asset_status_pending_approval.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset_status/asset_status.inc';

class Asset_Status_Pending_Approval extends Asset_Status
{


    function Asset_Status_Pending_Approval($owner)
    {
        $this->Asset_Status($owner);
        $this->status_tag = SQ_STATUS_PENDING_APPROVAL;

    }//end constructor


    public static function getDescription()
    {
        return translate('status_pending_approval');

    }//end getDescription()


    function getAvailableStatii()
    {

        $statii = Array();

        // cant do anything without write access
        if (!$this->owner->readAccess()) return $statii;

        $wfm = $GLOBALS['SQ_SYSTEM']->getWorkflowManager();
        $running_schemas = $wfm->getSchemas($this->owner->id, TRUE, TRUE);

        if (!empty($running_schemas)) {
            $userid = $GLOBALS['SQ_SYSTEM']->currentUserId();

            // check to see if the user logged in can publish
            $publishers = $wfm->whoCanPublish($this->owner->id);

            // if nobody can publish we better let admins do it
            $admin_access = $this->owner->adminAccess('');

            if (in_array($userid, $publishers) || $admin_access) {
                // the current user can approve this asset to keep the workflow going
                $wf_complete = $wfm->testPublish($this->owner->id, $GLOBALS['SQ_SYSTEM']->currentUserId());

                // we also need to check what if all the required metadata fields are completed
                $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();
                if ($mm->allowsMetadata($this->owner->id)) {
                    $m_complete = $mm->requiredFieldsComplete($this->owner->id);
                    $is_dependant =  $GLOBALS['SQ_SYSTEM']->am->isDependant($this->owner->id);

                    if ($wf_complete && (($m_complete && !$is_dependant) || $is_dependant)) {
                        $statii[SQ_STATUS_APPROVED] = translate('status_change_approve');
                    } else if (in_array($userid, $publishers)) {
                        $statii[SQ_STATUS_PENDING_APPROVAL] = translate('status_change_approve_changes');
                    }
                } else {
                    // this asset needs to allow both statuses because it cant check metadata requirements
                    // due to it not allowing metadata, but only if workflow is complete
                    if ($wf_complete) {
                        $statii[SQ_STATUS_APPROVED] = translate('status_change_approve');
                        $statii[SQ_STATUS_PENDING_APPROVAL] = translate('status_change_approve_changes');
                    }
                }

                $statii[SQ_STATUS_UNDER_CONSTRUCTION] = translate('status_change_reject_changes');
            }
        } else {
            // workflow is not currently running for this asset
            // but it should be because we are waiting for it to complete
            pre_echo('FIXME: SOMETHING HAS GONE WRONG HERE');
        }//end if workflow running

        return $statii;

    }//end getAvailableStatii()


    function processStatusChange($new_status, $update_parent=TRUE)
    {
        if (!parent::processStatusChange($new_status, $update_parent)) {
            return FALSE;
        }

        $wfm = $GLOBALS['SQ_SYSTEM']->getWorkflowManager();
        $current_userid = $GLOBALS['SQ_SYSTEM']->currentUserId();

        if ($new_status & SQ_SC_STATUS_CAN_APPROVE) {
            // someone has rejected the changes, so we need to cancel the workflow
            if (!$wfm->cancelWorkflow($this->owner->id)) {
                trigger_localised_error('SYS0260', E_USER_WARNING);
                return FALSE;
            } else {
                require_once SQ_INCLUDE_PATH.'/general_occasional.inc';

                // log an internal message
                $ms = $GLOBALS['SQ_SYSTEM']->getMessagingService();
                $user = $GLOBALS['SQ_SYSTEM']->am->getAsset($current_userid);
                if (!$wfm->silentWorkflowParty($this->owner->id)) {
                    $log = $ms->newMessage();
                    $msg_reps = Array(
                                    'user_name'     => $user->name,
                                    'workflow_user' => $user->name,
                                    'type_code'     => $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->owner->type(), 'name'),
                                    'asset_name'    => $this->owner->name,
                                    'status'        => get_status_description($new_status),
                                    'workflow_url'  => current_url().$this->owner->getBackendHref('workflow', FALSE),
                                );
                    $log->replacements = $msg_reps;
                    $asset_edt_fns = $this->owner->getEditFns();
                    if (isset($asset_edt_fns->static_screens['preview'])) {
                        $log->replacements['preview_url'] = current_url().$this->owner->getBackendHref('preview', FALSE);
                    } else {
                        $log->replacements['preview_url'] = current_url().$this->owner->getBackendHref('details', FALSE);
                    }
                    $log->type    = 'asset.workflow.log.reject';
                    $log->parameters['assetid'] = $this->owner->id;
                    $log->parameters['version'] = substr($this->owner->version, 0, strrpos($this->owner->version, '.'));
                    $log->send();
                }
            }

        } else {

            $running_schemas = $wfm->getSchemas($this->owner->id, TRUE, TRUE);
            if (!empty($running_schemas)) {

                // if we are trying to approve this asset, we might not actually be a person
                // in the workflow process - sounds weird (I know) but this could be a plain old
                // admin that is trying to approve because metadata is now complete.
                // the result is that this workflow process may already be complete
                $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();
                $m_complete = !$mm->allowsMetadata($this->owner->id) || $mm->requiredFieldsComplete($this->owner->id) || $GLOBALS['SQ_SYSTEM']->am->isDependant($this->owner->id);

                if ($wfm->isWorkflowComplete($this->owner->id) && $m_complete && ($new_status & SQ_SC_STATUS_ALL_APPROVED)) {
                    if (!$wfm->completeWorkflow($this->owner->id)) {
                        trigger_localised_error('SYS0261', E_USER_WARNING);
                        return FALSE;
                    }
                } else {
                    // we are doing a workflow and someone has just approved the asset, so record this
                    if (!$wfm->recordPublish($this->owner->id, $current_userid)) {
                        trigger_localised_error('SYS0077', E_USER_WARNING, $current_userid,$this->owner->name);
                        return FALSE;
                    }

                    // if the workflow process is now complete, we can go ahead and clear out the schemas
                    // as long as all our metadata is also complete
                    if ($wfm->isWorkflowComplete($this->owner->id) && $m_complete && ($new_status & SQ_SC_STATUS_ALL_APPROVED)) {
                        if (!$wfm->completeWorkflow($this->owner->id)) {
                            trigger_localised_error('SYS0261', E_USER_WARNING);
                            return FALSE;
                        }
                    }
                }

                // Since asset_status_editing_approval inherit from this object, it inherits this function, so when the asset go either from pending approval to approved, or editing approval to approved, lets send the asset workflow complete log message.
                if ($new_status == SQ_STATUS_APPROVED || $new_status == SQ_STATUS_EDITING_APPROVED) {

                    $ms = $GLOBALS['SQ_SYSTEM']->getMessagingService();
                    $user = $GLOBALS['SQ_SYSTEM']->am->getAsset($current_userid);
                    if (!$wfm->silentWorkflowParty($this->owner->id)) {
                        $log = $ms->newMessage();
                        $log->subject = 'Workflow Completed';
                        $msg_reps = Array(
                                        'type_code'     => $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->owner->type(), 'name'),
                                        'asset_name'    => $this->owner->name,
                                        'workflow_url'  => current_url().$this->owner->getBackendHref('workflow', FALSE),
                                    );

                        $log->replacements = $msg_reps;
                        $asset_edt_fns = $this->owner->getEditFns();
                        if (isset($asset_edt_fns->static_screens['preview'])) {
                            $log->replacements['preview_url'] = current_url().$this->owner->getBackendHref('preview', FALSE);
                        } else {
                            $log->replacements['preview_url'] = current_url().$this->owner->getBackendHref('details', FALSE);
                        }

                        $log->type    = 'asset.workflow.log.complete';
                        $log->parameters['assetid'] = $this->owner->id;
                        $log->parameters['version'] = substr($this->owner->version, 0, strrpos($this->owner->version, '.'));
                        $ms->enqueueMessage($log);
                    }

                }

            }//end if

        }//end else

        return TRUE;

    }//end processStatusChange()


}//end class

?>