metadata_schema_edit_fns.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/folder/folder_edit_fns.inc';

class Metadata_Schema_Edit_Fns extends Folder_Edit_Fns
{


    function __construct()
    {
        parent::__construct();
        $this->static_screens['details']['force_unlock'] = FALSE;
        $this->static_screens['details']['lock_type'] = 'content';

    }//end constructor


    public function paintNewSection(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        require_once SQ_LIB_PATH.'/html_form/html_form.inc';
        echo '<b>Section Name</b> ';
        text_box($prefix.'_new_section', '', 20);
        return TRUE;

    }//end paintNewSection()


    public function processNewSection(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;

        if (isset($_POST[$prefix.'_new_section']) && trim($_POST[$prefix.'_new_section'])) {
            $new_section_name = trim($_POST[$prefix.'_new_section']);
            $GLOBALS['SQ_SYSTEM']->am->includeAsset('metadata_section');
            $new_section = new Metadata_Section();
            $schema_link = Array('asset' => &$asset, 'link_type' => SQ_LINK_TYPE_2, 'sort_order' => -1, 'is_dependant' => 1);
            $new_section->setAttrValue('name', $new_section_name);
            if (!$new_section->create($schema_link)) return FALSE;
        }

        return TRUE;

    }//end processNewSection()


    public function paintRegenerate(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if ($asset->writeAccess('')) {
            $o->note(translate('metadata_regenerate_for_currently_applied'));
            check_box($prefix.'_regenerate');
            label(translate('metadata_regenerate_files'));
        } else {
            $o->note(translate('metadata_cannot_regenerate'));
        }

        return TRUE;

    }//end paintRegenerate()


    public function processRegenerate(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('')) return FALSE;

        if (isset($_POST[$prefix.'_regenerate']) && $_POST[$prefix.'_regenerate']) {
            $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();
            $vars = Array('schemaids' => Array($asset->id,));
            $hh->queueHipo('hipo_job_regenerate_metadata', $vars);
        }

        return TRUE;

    }//end processRegenerate()


    public function paintSections(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        require_once SQ_LIB_PATH.'/html_form/html_form.inc';
        $write_access = $asset->writeAccess('links');

        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', FALSE, 'major', NULL, TRUE, FALSE);
        foreach ($current_links as $link_data) {
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($section)) continue;

            $o->openSection($section->name);
                if ($write_access) {
                    $o->openField(translate('delete_question'));
                        check_box($prefix.'_delete_sections['.$link_data['linkid'].']');
                        label(translate('delete_section-field_question'));
                    $o->closeField();
                }
                $edit_fns = $section->getEditFns();
                if (!$edit_fns->paintInlineOptionInterface($section, $o)) {
                    return FALSE;
                }
            $o->closeSection();
        }

        return TRUE;

    }//end paintSections()


    public function processSections(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        // need to have write access to make any changes
        if (!$asset->writeAccess('links')) return FALSE;
        $updated = FALSE;

        // process current steps
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', FALSE, 'major', NULL, TRUE, FALSE);
        foreach ($current_links as $link_data) {
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link_data['minorid']);
            if (is_null($section)) continue;
            $edit_fns = $section->getEditFns();
            if ($edit_fns->processInlineOptionInterface($section, $o)) {
                $updated = TRUE;
            }
        }

        // delete any sections that need deleting
        if (isset($_POST[$prefix.'_delete_sections'])) {
            $delete_sections = $_POST[$prefix.'_delete_sections'];
            foreach ($delete_sections as $linkid => $on) {
                if ($asset->deleteLink($linkid)) $updated = TRUE;
            }
        }

        return $updated;

    }//end processSections()


    public function paintInlineValueInterface(Metadata_Schema $asset, Backend_Outputter $o, $values, $write_access, $print_cascade_values_option = TRUE, $type_code=NULL)
    {
        $o->openSection($asset->name);
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', FALSE, 'major', NULL, TRUE);
        $res = FALSE;
        foreach ($current_links as $link) {
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($section)) continue;
            $edit_fns = $section->getEditFns();
            if ($edit_fns->paintInlineValueInterface($section, $o, $values, $write_access, $print_cascade_values_option, $type_code)) {
                $res = TRUE;
            }
        }
        $o->closeSection();

        return $res;

    }//end paintInlineValueInterface()


    public function processInlineValueInterface(Metadata_Schema $asset, Array &$new_values, Array &$schema_cascade_values_asset_ids, $type_code=NULL)
    {
        $res = FALSE;
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', FALSE, 'major', NULL, TRUE);
        foreach ($current_links as $link) {
            $section_cascade_values_asset_ids = Array();
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($section)) continue;
            $edit_fns = $section->getEditFns();
             if ($edit_fns->processInlineValueInterface($section, $new_values, $section_cascade_values_asset_ids, $type_code)) {
                $res = TRUE;

                foreach($section_cascade_values_asset_ids as $asset_id => $val) {
                    $schema_cascade_values_asset_ids[$asset_id] = 1;
                }
            }
        }

        return $res;

    }//end processInlineValueInterface()


    public function requiredFieldsComplete(Metadata_Schema $asset, Array $values, $type_code=NULL)
    {
        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', FALSE, 'major', NULL, TRUE);
        foreach ($current_links as $link) {
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($section)) continue;
            $edit_fns = $section->getEditFns();
            if (!$edit_fns->requiredFieldsComplete($section, $values, $type_code)) {
                return FALSE;
            }
        }

        return TRUE;

    }//end requiredFieldsComplete()


    public function generateMetadata(Metadata_Schema $asset, Array &$values, Array &$tag_values, Array &$keywords, $type_code=NULL)
    {
        $frontend_option = $asset->attr('frontend');

        $mm = $GLOBALS['SQ_SYSTEM']->getMetadataManager();

        // Buffer the contents of any META tags
        ob_start();

        echo '<!-- '.$mm->escapeMetadata($asset->name).' //-->'."\n\n";

        $current_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($asset->id, SQ_LINK_TYPE_2, 'metadata_section', TRUE, 'major', NULL, TRUE);
        $valid_sections = Array();
        foreach ($current_links as $link) {
            $section = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($section)) continue;
            $valid_sections[] = $section->name;

            $edit_fns = $section->getEditFns();

            if (!$edit_fns->generateMetadata($section, $values, $tag_values, $keywords, $type_code)) {
                ob_end_clean();
                return FALSE;
            }

        }

        // If printing on front-end, print the META tags, otherwise discard them
        $contents = ob_get_clean();
        if ($frontend_option) echo $contents;

        return TRUE;

    }//end generateMetadata()


    //--        METADATA SCHEMA USAGE        --//


    public function paintUsage(Metadata_Schema $asset, Backend_Outputter $o, $prefix)
    {
        $page_size = 10;

        $o->openRaw();

        $schema_treeids_sql = 'SELECT
                                treeid, assetid, granted, cascades
                                FROM (sq_ast_lnk_tree ta
                                    JOIN sq_ast_lnk la ON ta.linkid = la.linkid
                                        JOIN sq_ast_mdata ma ON la.minorid = ma.assetid)
                                WHERE ma.schemaid = :schemaid
                                AND NOT EXISTS (
                                    SELECT * FROM (sq_ast_lnk_tree tb
                                                    JOIN sq_ast_lnk lb ON tb.linkid = lb.linkid
                                                        JOIN sq_ast_mdata mb ON lb.minorid = mb.assetid)
                                    WHERE mb.schemaid = ma.schemaid
                                    AND length(ta.treeid) - LENGTH(tb.treeid) = :tree_size AND SUBSTR(ta.treeid, 1, LENGTH(ta.treeid) - :tree_size_1) = tb.treeid
                                    AND ma.granted = mb.granted
                                    AND ma.cascades = mb.cascades
                                ) ORDER BY length(treeid), treeid';

        $query = MatrixDAL::preparePdoQuery($schema_treeids_sql);
        MatrixDAL::bindValueToPdo($query, 'schemaid', $asset->id);
        MatrixDAL::bindValueToPdo($query, 'tree_size', SQ_CONF_ASSET_TREE_SIZE);
        MatrixDAL::bindValueToPdo($query, 'tree_size_1', SQ_CONF_ASSET_TREE_SIZE);
        $treeids = MatrixDAL::executePdoAssoc($query);

        if (count($treeids) > 0) {
            $tree_tops = $this->_getTreeTops($asset, $treeids);

            $num_pages = ceil(count($tree_tops) / $page_size);
            $page_num = array_get_index($_POST, $prefix.'_usage_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.'_usage_page');
            }
            $asset_count_tag = translate('item_range', ($page_num - 1) * $page_size + 1, min(count($tree_tops), $page_num * $page_size), count($tree_tops), strtolower(translate('trees')));

            $tree_tops = array_slice($tree_tops, ($page_num - 1) * $page_size, $page_size);

            $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.'_usage_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.'_usage_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.'_usage_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.'_usage_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.'_usage_page', $page_num); ?>
            <table class="sq-backend-table">
            <thead>
            <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="2" style="text-align: right; font-weight: normal"><?php echo $asset_count_tag; ?></span></td>
            </tr>
            <tr class="sq-backend-table-row">
                <th class="sq-backend-table-cell"><?php echo translate('asset'); ?></th>
                <th style="width: 15%" class="sq-backend-table-cell"><?php echo translate('granted_question') ?></th>
                <th style="width: 15ex" class="sq-backend-table-cell"><?php echo translate('cascade_question') ?></th>
            </tr>
            </thead>
            <tbody>
            <?php

            foreach ($tree_tops as $tt_assetid => &$tree_top_info) {
                $root_tree = $tree_top_info;
                unset($root_tree['sub_trees']);
                $root_trees = array_merge(Array($root_tree), $tree_top_info['sub_trees']);

                foreach ($root_trees as $root_assetid => &$tree_info) {

                    ?><tr class="sq-backend-table-row">
                        <td class="sq-backend-table-cell">
                        <?php

                        $tag_line = get_asset_tag_line($tree_info['assetid'], 'details');

                        echo ($tree_info['depth'] === 0 ? '' : '<span style="padding-left: '.($tree_info['depth']*5).'ex">');
                        echo translate('asset_and_child_count_0', $tag_line);
                        echo ($tree_info['depth'] === 0 ? '' : '</span>');

                        ?></td>
                        <td class="sq-backend-table-cell">
                            <strong><span style="color: <?php echo (($tree_info['granted'] == '0') ? 'red' : 'green'); ?>"><?php echo (($tree_info['granted'] == '0') ? translate('denied') : translate('applied')) ?></span></strong>
                        </td>
                        <td class="sq-backend-table-cell">
                            <img src="<?php echo sq_web_path('lib'); ?>/web/images/<?php echo ($tree_info['cascades'] === '1' ? 'tick' : 'cross'); ?>.gif" width="15" height="15" style="vertical-align: middle;" alt="<?php echo translate($tree_info['cascades'] === '1' ? 'yes' : 'no'); ?>" />
                        </td>
                    </tr>
                    <?php
                }//end foreach entry

                unset($tree_info);

            }//end foreach top tree
            ?>

            </tbody>
            </table>
            <?php

            $o->note(translate('core_schema_usage_explanation'));

        } else {
            $o->note(translate('core_schema_usage_no_assets'));
        }

        $o->closeRaw();

        return FALSE;

    }//end paintUsage()


    public function _getTreeTops(Metadata_Schema $asset, Array $treeids)
    {
        $used_assetids = Array();

        $all_treeids = Array();
        foreach ($treeids as $treeid) {
            $all_treeids[$treeid['treeid']] = $treeid;
        }
        unset($treeids);

        $res = Array();
        foreach ($all_treeids as $tree_info) {
            $treeid = $tree_info['treeid'];
            $treeid_copy = $treeid;
            $top_parent  = $treeid;
            $depth       = 0;
            $used_sub_tree = FALSE;

            while (empty($treeid_copy) === FALSE) {
                if (isset($res[$treeid_copy]) === TRUE) {
                    if ($used_sub_tree === FALSE) {
                        $used_sub_tree = TRUE;
                    }
                }

                if (($used_sub_tree === TRUE) && (array_key_exists($treeid_copy, $all_treeids) === TRUE)) {
                    $top_parent = $treeid_copy;
                    $depth++;
                }

                $treeid_copy = substr($treeid_copy, 0, -SQ_CONF_ASSET_TREE_SIZE);
            }

            $res[$treeid] = $tree_info;
            $res[$treeid]['top_parent'] = $top_parent;
            $res[$treeid]['depth'] = $depth;
            $res[$treeid]['sub_trees'] = Array();

            // Have we seen this asset before? If so, let it go, but mark it
            // to be dumped afterwards so we only have one of each asset
            if (array_search($tree_info['assetid'], $used_assetids) === FALSE) {
                $res[$treeid]['dupe'] = FALSE;
                $used_assetids[] = $tree_info['assetid'];
            } else {
                $res[$treeid]['dupe'] = TRUE;
            }
        }

        foreach ($res as $key => &$res_item) {
            if ($res_item['dupe'] === TRUE) {
                unset($res[$key]);
            } else {
                if ($res_item['depth'] > 0) {
                    $res[$res_item['top_parent']]['sub_trees'][$res_item['treeid']] =& $res_item;
                    unset($res[$key]);
                }
            }
        }

        // Sort each sub-tree top-to-bottom, to ensure correct tree order
        foreach ($res as $key => &$res_item) {
            uksort($res_item['sub_trees'], create_function('$key1,$key2', 'return strcmp($key1, $key2);'));
        }

        unset($res_item);

        return $res;

    }//end _getTreeTops()


}//end class

?>