asset_edit_fns.inc

<?php
require_once SQ_LIB_PATH.'/html_form/html_form.inc';

class Asset_Edit_Fns extends MySource_Object
{

    var $static_screens = Array(
                            'details'           => Array(
                                                    'name'          => 'Details',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'menu',
                                                   ),
                            'permissions'       => Array(
                                                    'name'          => 'Permissions',
                                                    'force_unlock'  => FALSE,
                                                    'lock_type'     => 'permissions',
                                                   ),
                            'workflow'          => Array(
                                                    'name'          => 'Workflow',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'workflow',
                                                   ),
                            'roles'             => Array(
                                                    'name'          => 'Roles',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'roles',
                                                   ),
                            'metadataSchemas'   => Array(
                                                    'name'          => 'Metadata Schemas',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'metadata',
                                                   ),
                            'metadata'          => Array(
                                                    'name'          => 'Metadata',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'metadata',
                                                   ),
                            'dependants'        => Array(
                                                    'name'          => 'Dependants',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'none',
                                                   ),
                            'linking'           => Array(
                                                    'name'          => 'Linking',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'links',
                                                   ),
                            'settings'          => Array(
                                                    'name'          => 'Settings',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'all',
                                                   ),
                            'history'           => Array(
                                                    'name'          => 'History',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'none',
                                                   ),
                            'logs'              => Array(
                                                    'name'          => 'Logs',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'none',
                                                   ),
                            'preview'           => Array(
                                                    'name'          => 'Preview',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'none',
                                                   ),
                            'lookupValues'      => Array(
                                                    'name'          => 'Lookup Settings',
                                                    'force_unlock'  => FALSE,
                                                    'lock_type'     => 'lookupValues',
                                                   ),
                            'tagging'           => Array(
                                                    'name'          => 'Tagging',
                                                    'force_unlock'  => TRUE,
                                                    'lock_type'     => 'menu',
                                                   ),
                            'layouts'           => Array(
                                                    'name'          => 'Layouts',
                                                    'force_unlock'  => FALSE,
                                                    'lock_type'     => 'all',
                                                   ),
                          );


    function Asset_Edit_Fns()
    {
        $this->MySource_Object();

    }//end constructor


    function paintPaths(&$asset, &$o, $prefix)
    {

        $wa = $asset->writeAccess('lookups');

        $paths = $asset->getWebPaths();

        foreach ($paths as $path) {
            if ($wa) {
                text_box($prefix.'_paths[]', $path, 25);
            } else {
                echo $path;
            }
            echo '<br/>';
        }

        if ($wa) text_box($prefix.'_paths[]', '', 25);

        return $wa;

    }//end paintPaths()


    function paintEditRemapURLs(&$asset, &$o, $prefix)
    {
        $admin_access = $asset->adminAccess('lookups');

        $remap_manager = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('remap_manager');
        $remap_urls = $remap_manager->getRemapURLs($asset);

        if (empty($remap_urls)) {
            echo translate('no_associated_remaps');
            return FALSE;
        }

        $num_per_page = 100;
        $total_assets = count($remap_urls);
        $num_pages = ceil($total_assets / $num_per_page);

        $page_num = array_get_index($_POST, $prefix.'_remap_urls_page', 1);
        $page_num = max($page_num, 1);
        $page_num = min($page_num, $num_pages);

        if ($num_pages == 1) {
            $page_tag = translate('page_number', $page_num, $num_pages);
        } else {
            $page_tag = translate('page_number_with_pager', $page_num, $num_pages, $prefix.'_remap_urls_page');
        }
        $asset_count_tag = translate('item_range', ($page_num - 1) * $num_per_page + 1, min($total_assets, $page_num * $num_per_page), $total_assets, strtolower(translate('remap_entries')));

        $remap_urls = array_slice($remap_urls, ($page_num - 1) * $num_per_page, $num_per_page);

        $links = Array(
                    'first'     => '&lt;&lt;',
                    'previous'  => '&lt;',
                    'page'      => $page_tag,
                    'next'      => '&gt;',
                    'last'      => '&gt;&gt;',
                );

        if ($page_num > 1) {
            $links['first'] = '<a title="'.translate('pagination_go_to_first').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_remap_urls_page\', 1)">'.$links['first'].'</a>';
            $links['previous'] = '<a title="'.translate('pagination_go_to_previous').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_remap_urls_page\', '.($page_num - 1).')">'.$links['previous'].'</a>';
        } else {
            $links['first'] = '<span title="'.translate('pagination_cannot_go_further_back').'." style="color: #333">'.$links['first'].'</span>';
            $links['previous'] = '<span title="'.translate('pagination_cannot_go_further_back').'." style="color: #333">'.$links['previous'].'</span>';
        }

        if ($page_num < $num_pages) {
            $links['last'] = '<a title="'.translate('pagination_go_to_last').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_remap_urls_page\', '.$num_pages.')">'.$links['last'].'</a>';
            $links['next'] = '<a title="'.translate('pagination_go_to_next').'" style="text-decoration: none; color: #fff" href="#" onClick="return sq_pager_jump(\''.$prefix.'_remap_urls_page\', '.($page_num + 1).')">'.$links['next'].'</a>';
        } else {
            $links['last'] = '<span title="'.translate('pagination_cannot_go_further_forward').'." style="color: #333">'.$links['last'].'</span>';
            $links['next'] = '<span title="'.translate('pagination_cannot_go_further_forward').'." style="color: #333">'.$links['next'].'</span>';
        }

        hidden_field($prefix.'_remap_urls_page', $page_num); ?>

        <table class="sq-backend-table">
            <tr class="sq-backend-table-row">
                <td class="sq-backend-table-header-header"><?php echo implode(' &nbsp; &nbsp; ', $links) ?></td>
                <td class="sq-backend-table-header-header" colspan="<?php echo ($admin_access === TRUE) ? 5 : 4 ?>" style="text-align: right; font-weight: normal"><?php echo $asset_count_tag; ?></span></td>
            </tr>
            <tr>
                <td class="sq-backend-table-header"><?php echo translate('url'); ?></td>
                <td class="sq-backend-table-header"><?php echo translate('remap_url'); ?></td>
                <td class="sq-backend-table-header"><?php echo translate('expires'); ?></td>
                <td class="sq-backend-table-header"><?php echo translate('type'); ?></td>
                <?php
                    if ($admin_access) {
                        ?>
                        <td class="sq-backend-table-header">
                            <?php
                            check_box($prefix.'_select_all', '1', FALSE, "check_all(document.main_form, '{$prefix}_delete_remap', this.checked);");
                            label(translate('delete_question'), $prefix.'_select_all');
                            ?>
                        </td>
                        <?php
                    }
                ?>
                <td class="sq-backend-table-header"><?php echo translate('never_delete'); ?></td>
            </tr>
            <?php
                foreach ($remap_urls as $url_info) {
                    if (empty($url_info['expires'])) {
                        $expires = translate('never');
                    } else {
                        $expires = $GLOBALS['SQ_SYSTEM']->datetime(iso8601_ts($url_info['expires']));
                    }
                ?>
                <tr>
                    <td class="sq-backend-table-cell"><?php echo $url_info['url']; ?></td>
                    <td class="sq-backend-table-cell"><?php echo $url_info['remap_url']; ?></td>
                    <td class="sq-backend-table-cell"><?php echo $expires; ?></td>
                    <td class="sq-backend-table-cell"><?php echo ((int)$url_info['auto_remap'] === 1) ? translate('automatic') : (($url_info['auto_remap'] === NULL) ? translate('unknown') : translate('manual')); ?></td>
                    <?php
                        if ($admin_access) {
                            ?>
                            <td class="sq-backend-table-cell">
                                <?php
                                check_box($prefix.'_delete_remap['.$url_info['url'].']', 1, FALSE, '', $url_info['never_delete'] ? 'disabled' : '');
                                ?>
                            </td>
                            <?php
                        }
                    ?>
                    
                    <td class="sq-backend-table-cell"><img src="<?php echo sq_web_path('lib')."/web/images/".($url_info['never_delete'] ? "tick.gif" : "cross.gif"); ?>" width="15" height="15" /></td>
                </tr>
                <?php
                }//end foreach
            ?>
        </table>

        <?php

        return $admin_access;

    }//end paintEditRemapURLs()


    function processPaths(&$asset, &$o, $prefix)
    {
        if (!isset($_POST[$prefix.'_paths'])) return FALSE;

        // Add remaps only if they are to be automatically added when the web path is changed. The default behaviour
        // is to add remaps. This functionality is controlled by a global switch in the Remap Manager and can be overridden
        // on the Web Paths screen (per asset) on a one-shot basis when changing web paths

        $auto_add_remaps = isset($_POST[$prefix.'_remap_upon_webpath_change']);

        if (!$asset->saveWebPaths(array_values($_POST[$prefix.'_paths']), $auto_add_remaps)) {
            return FALSE;
        }

        $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();
        $vars = Array('assetids' => Array($asset->id));
        $hh->queueHipo('hipo_job_update_lookups', $vars);

        return TRUE;

    }//end processPaths()


    function processEditRemapURLs(&$asset, &$o, $prefix)
    {
        if (!$asset->adminAccess('lookups')) return FALSE;

        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        if (isset($_POST[$prefix.'_delete_remap'])) {
            $urls = array_keys($_POST[$prefix.'_delete_remap']);

            $remap_manager = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('remap_manager');
            $remap_urls = $remap_manager->getRemapURLs($asset);

            foreach ($remap_urls as $url_info) {
                foreach ($urls as $index => $url_to_delete) {
                    if ($url_info['url'] === $url_to_delete && $url_info['never_delete']) {
                        unset($urls[$index]);
                    }
                }
            }

            try {
                $bind_vars = Array('urls' => $urls);
                MatrixDAL::executeQuery('remap_manager', 'deleteRemapsByURL', $bind_vars);
            } catch (DALException $e) {
                throw new Exception('Unable to delete remaps due to database error: '.$e->getMessage());
            }
        }

        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        return TRUE;

    }//end processEditRemapURLs()


    function paintURLs(&$asset, &$o, $prefix)
    {
        $urls = $asset->getLookups();
        if (empty($urls)) {
            echo translate('no_associated_urls');
        } else {
            usort($urls, create_function('$a, $b', 'return strcmp($a[\'url\'], $b[\'url\']);'));
            foreach ($urls as $data) {
                if ($data['http']) {
                    echo 'http://'.$data['url'], '<br/>';
                }
                if ($data['https']) {
                    echo 'https://'.$data['url'], '<br/>';
                }
            }
        }

        if ($asset->force_secure === '1') {
            echo '<br>';
            $o->note(translate('force_secure_set_on_asset'));
        }

    }//end paintURLs()


    function paintAddRemapURLs(&$asset, &$o, $prefix)
    {
        if (!$asset->adminAccess('lookups')) return FALSE;

        $urls = $asset->getURLs();
        if (empty($urls)) {
            $o->openField(translate('url_remappings'));
                label(translate('url_remap_no_associated_asset_urls'));
            $o->closeField();

            return FALSE;
        }

        foreach ($urls as $url) {
            if ($url['http'] == 1) {
                $contents['http://'.$url['url']] = 'http://'.$url['url'];
            }
            if ($url['https'] == 1) {
                $contents['https://'.$url['url']] = 'https://'.$url['url'];
            }
        }

        $remap_manager = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('remap_manager');
        $never_delete = ($remap_manager->attr('never_delete_remap_default') == FALSE) ? 0 : 1;

        $o->openField(translate('old_url'));
            text_box($prefix.'_add_remap_old_url', '', 50);
        $o->closeField();

        $o->openField(translate('new_url'));
            combo_box($prefix.'_add_remap_new_url', $contents);
        $o->note(translate('url_remap_explanation'));
        $o->closeField();

        $o->openField(translate('expires'));
            text_box($prefix.'_add_remap_expires_days', '', 5);
            label(translate('days'), $prefix.'_add_remap_expires_days');
        $o->closeField();

        $o->openField(translate('never_delete'));
            check_box($prefix.'_add_remap_never_delete', TRUE, $never_delete);
        $o->closeField();

    }//end paintAddRemapURLs()


    function processAddRemapURLs(&$asset, &$o, $prefix)
    {
        if (!$asset->adminAccess('lookups')) return FALSE;

        // now add a manually set remap if we have on to set
        if (!isset($_POST[$prefix.'_add_remap_old_url']) || !isset($_POST[$prefix.'_add_remap_new_url'])) {
            return FALSE;
        }
        $old_url = trim($_POST[$prefix.'_add_remap_old_url']);
        $new_url = trim($_POST[$prefix.'_add_remap_new_url']);
        $expires = NULL;

        if (empty($old_url)) return FALSE;

        if (isset($_POST[$prefix.'_add_remap_expires_days'])) {
            $expires_days = (int)$_POST[$prefix.'_add_remap_expires_days'];
            if ($expires_days > 0) {
                $expires = strtotime('+ '.$expires_days.' days');
            }
        }

        $remap_manager = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('remap_manager');
        $never_delete = isset($_POST[$prefix.'_add_remap_never_delete']) ? 1 : 0;
        $remap_manager->addRemapURL($old_url, $new_url, $expires, $never_delete, FALSE);

        return TRUE;

    }//end processAddRemapURLs()


    function isWorkflowComplete(&$asset)
    {
        return $GLOBALS['SQ_SYSTEM']->getWorkflowManager()->isWorkflowComplete($asset->id);

    }//end isWorkflowComplete()


    function paintNoticeLinkedAsset(&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
    {
        if ($multiple) {
            $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_NOTICE, '', FALSE, 'major', $link_value);
        } else {
            $link = $GLOBALS['SQ_SYSTEM']->am->getLink($asset->id, SQ_LINK_NOTICE, '', FALSE, $link_value);
            $links = empty($link) ? Array() : Array($link);
        }

        if (empty($field_name)) {
            $field_name = $asset->getPrefix().'_'.str_replace(' ', '_', strtolower($link_value));
        }

        if (!$asset->writeAccess('links')) {
            if (empty($links)) {
                echo '<i>'.translate('none').'</i>';
            } else {
                foreach ($links as $link) {
                    echo get_asset_tag_line($link['minorid']);
                }
            }
            return FALSE;
        } else {
            if ($multiple) {
                $current = Array();
                foreach ($links as $link) {
                    $current[] = $link['minorid'];
                }
                multiple_asset_finder($field_name, $current, $type_codes);
            } else {
                $current = empty($links) ? 0 : $links[0]['minorid'];
                asset_finder($field_name, $current, $type_codes);
            }
            return TRUE;
        }

    }//end paintNoticeLinkedAsset()


    function processNoticeLinkedAsset(&$asset, $link_value, $field_name='', $multiple=FALSE)
    {
        if (empty($field_name)) {
            $field_name = $asset->getPrefix().'_'.str_replace(' ', '_', strtolower($link_value));
        }
        if (!isset($_POST[$field_name])) return FALSE;

        if ($multiple) {

            $submitted_minorids = Array();
            foreach ($_POST[$field_name] as $elt) {
                if (!empty($elt['assetid'])) {
                    $submitted_minorids[] = $elt['assetid'];
                }
            }
            $submitted_minorids = array_unique($submitted_minorids);

            $existing_minorids = Array();
            $to_delete = Array();
            $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_NOTICE, '', FALSE, 'major', $link_value);
            foreach ($links as $link) {
                if (in_array($link['minorid'], $submitted_minorids)) {
                    $existing_minorids[] = $link['minorid'];
                } else {
                    $to_delete[] = $link['linkid'];
                }
            }
            $to_add = array_diff($submitted_minorids, $existing_minorids);
            $to_delete = array_unique($to_delete);

            if (empty($to_add) && empty($to_delete)) {
                return FALSE;
            }

            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');
            $success = TRUE;

            foreach ($to_add as $schemaid) {
                $schema = $GLOBALS['SQ_SYSTEM']->am->getAsset($schemaid);
                if (!$GLOBALS['SQ_SYSTEM']->am->createAssetLink($asset, $schema, SQ_LINK_NOTICE, $link_value)) {
                    $success = FALSE;
                    break;
                }
            }

            foreach ($to_delete as $linkid) {
                if (!$GLOBALS['SQ_SYSTEM']->am->deleteAssetLink($linkid)) {
                    $success = FALSE;
                    break;
                }
            }

            $GLOBALS['SQ_SYSTEM']->doTransaction($success ? 'COMMIT' : 'ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        } else {

            $link = $GLOBALS['SQ_SYSTEM']->am->getLink($asset->id, SQ_LINK_NOTICE, '', FALSE, $link_value);

            // if there has been no change, then there is nothing to do
            if (!empty($link) && $link['minorid'] == $_POST[$field_name]['assetid']) {
                return FALSE;
            }

            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');
            $success = TRUE;

            // if there is a current link, we need to delete it
            if (!empty($link)) {
                $success = (bool) $asset->deleteLink($link['linkid']);
            }

            if ($success && !empty($_POST[$field_name]['assetid'])) {
                $selected_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($_POST[$field_name]['assetid']);
                if (!is_null($selected_asset)) {
                    $success = (bool) $asset->createLink($selected_asset, SQ_LINK_NOTICE, $link_value);
                }
            }

            $GLOBALS['SQ_SYSTEM']->doTransaction($success ? 'COMMIT' : 'ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        }
        return $success;

    }//end processNoticeLinkedAsset()


    function isSearchInstalled(&$asset, $prefix)
    {
        return $GLOBALS['SQ_SYSTEM']->am->installed('search_manager');

    }//end isSearchInstalled()


    function isBeingCreated(&$asset)
    {
        return ($asset->id == 0);

    }//end isBeingCreated()


    function isNotBeingCreated(&$asset)
    {
        return !$this->isBeingCreated($asset);

    }//end isNotBeingCreated()


        function paintAutomaticRemapSetting(&$asset, &$o, $prefix)
        {
                $write_access = $asset->writeAccess('lookups');

        if ($write_access) {
            $o->closeField();

            $o->openField(translate('web_paths_auto_add_remaps'));
                $rm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('remap_manager');
                        $remap_upon_webpath_change = $rm->attr('remap_upon_webpath_change');

                        // paint checkbox
                check_box($prefix.'_remap_upon_webpath_change', TRUE, $remap_upon_webpath_change);

                $o->note(translate('web_paths_auto_add_remaps_note'));
            $o->closeField();
                }


                return $write_access;

        }//end paintAutomaticRemapSetting()

        
    function paintCreateLink(&$asset, &$o, $prefix)
    {
        $editable_link_types = Array(
                            SQ_LINK_TYPE_1  => link_type_name(SQ_LINK_TYPE_1),
                            SQ_LINK_TYPE_2  => link_type_name(SQ_LINK_TYPE_2),
                           );
                           
        if (isset($_REQUEST['parent_assetid'])){
            $restricted_sites = $GLOBALS['SQ_SYSTEM']->getUserPrefs('site', 'SQ_CHILD_CREATE_LINK_TYPE_2_RESTRICT');
            $parent_sites = array_keys($GLOBALS['SQ_SYSTEM']->am->getParents($_REQUEST['parent_assetid'], 'site'));
            $asset_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($_REQUEST['parent_assetid'], 'site');
            if (!empty($asset_info)) $parent_sites[] = $_REQUEST['parent_assetid'];

            if (array_intersect($restricted_sites, $parent_sites) != Array()) {
                unset($editable_link_types[SQ_LINK_TYPE_1]);
                $_REQUEST['link_type'] = SQ_LINK_TYPE_2;
            }
        }
        
        $o->closeField();
        $o->openField(translate('link_type'));
        combo_box('link_type', $editable_link_types, FALSE, isset($_REQUEST['link_type']) ? $_REQUEST['link_type'] : SQ_LINK_TYPE_1);
        $o->closeField();
        return TRUE;

    }//end paintCreateLink()

}//end class
?>