user_group_edit_fns.inc

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

class User_Group_Edit_Fns extends Folder_Edit_Fns
{


    function User_Group_Edit_Fns()
    {
        $this->Folder_Edit_Fns();

    }//end constructor


    function getCurrentRestrictions(&$asset)
    {
        $db = MatrixDAL::getDb();

        $sql = 'SELECT type_code, screen, section
                FROM '.SQ_TABLE_RUNNING_PREFIX.'ast_edit_access ';
        $where = 'userid = :userid';
        $where = $GLOBALS['SQ_SYSTEM']->constructRollbackWhereClause($where);

        try {
            $query  = MatrixDAL::preparePdoQuery($sql.$where);
            MatrixDAL::bindValueToPdo($query, 'userid', $asset->id);

            $result = MatrixDAL::executePdoGroupedAssoc($query);
        } catch (Exception $e) {
            throw new Exception('Unable to get current restriction information for userid #'.$asset->id.' due to the following database error:'.$e->getMessage());
        }//end try catch

        return $result;

    }//end getCurrentRestrictions()


    function isRestricted(&$asset, $prefix)
    {
        $current = $this->getCurrentRestrictions($asset);
        return !empty($current);

    }//end isRestricted()


    function paintTypeRestrictions(&$asset, &$o, $prefix)
    {
        $current = $this->getCurrentRestrictions($asset);
        $admin_access = $asset->adminAccess('security');

        if (empty($current) && !$admin_access) {
            $o->openField('');
                $o->note(translate('user_group_unrestricted_access_granted'));
            $o->closeField();
        }

        foreach ($current as $type_code => $type_data) {
            if ($type_code == '0') continue;

            $o->openSection($type_code);
                $o->openField('');
                    ?>
                    <table class="sq-backend-table">
                        <tr>
                            <td class="sq-backend-table-header" style="width: 75%;"><?php echo translate('screen_name'); ?></td>
                            <?php if ($admin_access) {
                            ?><td class="sq-backend-table-header" style="width: 25%;"><?php echo translate('remove_question'); ?></td><?php
                            }
                        ?></tr>
                    <?php
                    $granted_screens = Array();
                    foreach ($type_data as $screen_data) {
                        $granted_screens[] = $screen_data['screen'];
                        if ($screen_data['screen'] == '0') {
                            $screen_name = '<b>'.translate('all_screens').'</b>';
                        } else {
                            $screen_name = ucwords(str_replace('_', '', $screen_data['screen']));
                        }
                        ?>
                        <tr>
                            <td class="sq-backend-table-cell"><?php echo $screen_name; ?></td>
                            <?php if ($admin_access) {
                                ?><td class="sq-backend-table-cell">
                                <?php check_box($prefix.'_remove_type_screen['.$type_code.']['.$screen_data['screen'].']'); ?>
                            </td>
                            <?php
                            }
                            ?>
                        </tr>
                        <?php
                    }
                    ?>
                    </table>

                    <?php
                    if ($admin_access) {
                        if (!in_array('0', $granted_screens)) {
                            $ei = new Asset_Edit_Interface($type_code);

                            $GLOBALS['SQ_SYSTEM']->am->includeAsset($type_code);
                            $asset = new $type_code();
                            $ef = $asset->getEditFns();

                            $screens = Array(' ' => ''); // first option is blank
                            $screens['0'] = '-- '.translate('all_screens').' --'; // second option is 'All Screens'
                            foreach (array_keys($ef->static_screens) as $screen) {
                                if (in_array($screen, $granted_screens)) continue;
                                $screens[$screen] = ucfirst($screen);
                            }
                            foreach (array_keys($ei->getScreens()) as $screen) {
                                if (in_array($screen, $granted_screens)) continue;
                                $screens[$screen] = ucfirst($screen);
                            }

                            echo '<br />'.translate('grant_screen_access').' ';
                            combo_box($prefix.'_add_type_screen['.$type_code.']', $screens, FALSE, Array());
                        } else {
                            echo '<br />'.translate('granted_unrestricted_access_explanation');
                            if (count($current[$type_code]) == 1) {
                                echo '<br />'.translate('remove_all_screens_explanation');
                            }
                        }
                    }

                $o->closeField();
            $o->closeSection();
        }//end foreach type code

        // allow them to restrict access to asset types
        if ($admin_access) {
            $uc_types = Array();
            $types = $GLOBALS['SQ_SYSTEM']->am->getTypeList();
            asort($types);
            foreach ($types as $type) {
                if (isset($current[$type])) continue;
                $uc_types[$type] = ucwords(str_replace('_',' ', $type));
            }

            $o->openSection(translate('restrict_screen_access_to_new_type'));
                $o->openField('');
                    combo_box($prefix.'_restrict_types', $uc_types, TRUE, '', 6);
                $o->closeField();
            $o->closeSection();
        }

        return $admin_access;

    }//end paintTypeRestrictions()


    function processTypeRestrictions(&$asset, &$o, $prefix)
    {
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $db = MatrixDAL::getDb();
        $current = $this->getCurrentRestrictions($asset);

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

        $bind_vars  = Array (
                            'userid'    => $asset->id,
                      );

         //  ADD ACCESS FOR NEW ASSET TYPES  //
        if (isset($_POST[$prefix.'_restrict_types'])) {
            $new_types = $_POST[$prefix.'_restrict_types'];


            foreach ($new_types as $type) {
                if (isset($current[$type])) continue;

                $bind_vars['type_code'] = $type;
                $bind_vars['screen']    = 'details';

                try {
                    $result = MatrixDAL::executeQuery('user_group', 'addScreenSectionRestrictionForUser', $bind_vars);
                } catch (Exception $e) {
                    throw new Exception('Unable to add access for new asset type due to the following database error:'.$e->getMessage());
                }//end try catch
            }//end foreach

        }//end if


         //  REMOVE ACCESS TO SCREENS  //
        if (isset($_POST[$prefix.'_remove_type_screen'])) {
            $doomed_screens = $_POST[$prefix.'_remove_type_screen'];
            foreach ($doomed_screens as $type_code => $screen_data) {
                // Here we set the type code for the bind variable array.
                $bind_vars['type_code'] = $type_code;
                $bind_vars['screen']    = 'details';

                foreach ($screen_data as $doomed_screen => $on) {

                    if ($doomed_screen == '0' && count($current[$type_code]) == 1) {
                        // deleting the All Screens option without having a fall back
                        // option to stop this whole type being deleted
                        // so we'll add one
                        try {
                            $result = MatrixDAL::executeQuery('user_group', 'addScreenSectionRestrictionForUser', $bind_vars);
                        } catch (Exception $e) {
                            throw new Exception('Unable to add access for userid #'.$asset->id.' due to the following database error:'.$e->getMessage());
                        }//end try catch
                    }
                    // note that we need to put quote around the doomed screen to ensure
                    // it is treated like a string and thus does not blow away all entries
                    // for the type code from the DB

                    $bind_vars['screen'] = $doomed_screen;

                    try {
                        $result = MatrixDAL::executeQuery('user_group', 'deleteAccessRestrictionForUser', $bind_vars);
                    } catch (Exception $e) {
                        throw new Exception('Unable to delete access for userid #'.$asset->id.' due to the following database error:'.$e->getMessage());
                    }//end try catch

                }//end foreach doomed screen
            }//end foreach type code
        }//end if


         //  GRANT ACCESS TO SCREENS  //
        if (isset($_POST[$prefix.'_add_type_screen'])) {
            $new_screens = $_POST[$prefix.'_add_type_screen'];

            foreach ($new_screens as $type_code => $new_screen) {
                if (trim($new_screen) == '') continue;
                // Here we set the type code for the bind variable array.
                $bind_vars['type_code'] = $type_code;
                $bind_vars['screen']    = $new_screen;

                try {
                    $result = MatrixDAL::executeQuery('user_group', 'addScreenSectionRestrictionForUser', $bind_vars);
                } catch (Exception $e) {
                    throw new Exception('Unable to add access for new asset type due to the following database error:'.$e->getMessage());
                }//end try catch

            }//end foreach
        }//end if

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

        return TRUE;

    }//end processTypeRestrictions()


    function paintPreferences(&$asset, &$o, $prefix)
    {
        $write_access = $asset->adminAccess('preferences');

        $pref_file_path = $asset->data_path.'/.preferences.inc';
        if (is_file($pref_file_path)) {
            include $pref_file_path;
            $custom_preferences = $preferences;
        } else {
            $custom_preferences = Array();
        }

        include SQ_DATA_PATH.'/private/conf/preferences.inc';

        foreach ($preferences as $type_code => $pref_vars) {
            $o->openSection($GLOBALS['SQ_SYSTEM']->am->getTypeInfo($type_code, 'name').' Preferences');
                // load up the asset (for locale) and prefs to display
                $GLOBALS['SQ_SYSTEM']->am->includeAsset($type_code);
                $path = SQ_SYSTEM_ROOT.'/'.$GLOBALS['SQ_SYSTEM']->am->getTypeInfo($type_code, 'dir').'/'.$type_code.'_prefs.inc';
                require_once $path;
                $pref_name = $type_code.'_Prefs';
                $prefs = new $pref_name($pref_file_path);

                foreach ($pref_vars as $var_name => $var_data) {
                    $o->openField(translate($var_data['name']));
                        if (isset($custom_preferences[$type_code][$var_name])) {
                            echo '<p>'.translate('preference_currently_customised');
                            if ($write_access) {
                                echo '<br />';
                                check_box($prefix.'_revert['.$type_code.']['.$var_name.']');
                                echo ' <b>'.translate('revert_to_global_preferences').'</b>';
                            }
                            echo '</p>';
                            $prefs->paintBackend($o, $write_access, $var_name);
                        } else {
                            echo '<p>'.translate('preference_not_customised');
                            if ($write_access) {
                                echo '<br />';
                                check_box($prefix.'_customise['.$type_code.']['.$var_name.']');
                                echo ' <b>'.translate('customise_this_preference').'</b>';
                            }
                            echo '</p>';
                        }
                    $o->closeField();
                }
            $o->closeSection();
        }

        return $write_access;

    }//end paintPreferences()


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

        $new_preferences = Array();

        if (isset($_POST[$prefix.'_customise'])) {
            // customising global preferences
            include SQ_DATA_PATH.'/private/conf/preferences.inc';
            foreach ($_POST[$prefix.'_customise'] as $type_code => $var_data) {
                foreach ($var_data as $var_name => $on) {
                    if (isset($preferences[$type_code][$var_name])) {
                        $new_preferences[$type_code][$var_name] = $preferences[$type_code][$var_name];
                    }
                }
            }
        }

        $pref_file_path = $asset->data_path.'/.preferences.inc';
        if (is_file($pref_file_path)) {
            include $pref_file_path;
            foreach ($preferences as $type_code => $pref_vars) {
                $path = SQ_SYSTEM_ROOT.'/'.$GLOBALS['SQ_SYSTEM']->am->getTypeInfo($type_code, 'dir').'/'.$type_code.'_prefs.inc';
                require_once $path;
                $pref_name = $type_code.'_Prefs';
                $prefs = new $pref_name();
                foreach ($pref_vars as $var_name => $var_data) {
                    if (!isset($_POST[$prefix.'_revert'][$type_code][$var_name])) {
                        if ($prefs->processBackend($o, TRUE, $var_name)) {
                            $new_preferences[$type_code][$var_name] = $prefs->pref_vars[$var_name];
                        }
                    }
                }
            }
        }

        require_once SQ_FUDGE_PATH.'/general/file_system.inc';
        $str = '<'.'?php $preferences = '.var_export($new_preferences, TRUE).'; ?'.'>';
        if (!is_dir($asset->data_path) && !create_directory($asset->data_path)) {
            return FALSE;
        }
        if (!string_to_file($str, $asset->data_path.'/.preferences.inc')) {
            return FALSE;
        }

        return TRUE;

    }//end processPreferences()


    function _printRoleTable($prefix, $pag_id, $roles, $write_access=FALSE, $include_userid=FALSE)
    {
        if (empty($roles)) return;

        ?>
        <table class="sq-backend-table">
            <tr>
                <?php
                    if ($include_userid) {
                        ?><th class="sq-backend-table-header"><?php echo translate('role_assigned_to'); ?></td><?php
                    }
                ?>
                <th class="sq-backend-table-header"><?php echo translate('role'); ?></td>
                <th class="sq-backend-table-header">Asset for which the role is to be performed</td>
                <?php
                    if ($write_access) {
                        ?><th class="sq-backend-table-header"><?php echo translate('role_reassign'); ?></td><?php
                    }
                ?>
            </tr>
        <?php

        $num_roles = 0;
        $num_printed  = 0;
        $roles_pointer = 0;
        $num_per_page = 10;

        $start_printing_at = array_get_index($_REQUEST, $prefix.$pag_id.'_start_at', 0);
        $role_tag_lines = Array();
        $user_tag_lines = Array();
        $asset_tag_lines = Array();

        foreach ($roles as $roleid => $userids) {
            foreach ($userids as $userid => $assetids) {
                $num_roles += count($assetids);
                foreach ($assetids as $assetid) {
                    if ($roles_pointer < $start_printing_at) {
                        $roles_pointer++;
                        continue;
                    }
                    if ($roles_pointer >= $start_printing_at + $num_per_page) {
                        break 2;
                    }

                    if (!isset($asset_tag_lines[$assetid])) {
                        $asset_tag_lines[$assetid] = get_asset_tag_line($assetid);
                    }
                    if (!isset($role_tag_lines[$roleid])) {
                        $role_tag_lines[$roleid] = get_asset_tag_line($roleid);
                    }

                ?>
                    <tr>
                        <?php
                            if ($include_userid) {
                                if (!isset($user_tag_lines[$userid])) {
                                    $user_tag_lines[$userid] = get_asset_tag_line($userid);
                                }
                                ?><td class="sq-backend-table-cell"><?php echo $user_tag_lines[$userid]; ?></td><?php
                            }
                        ?>
                        <td class="sq-backend-table-cell"><?php echo $role_tag_lines[$roleid] ?></td>
                        <td class="sq-backend-table-cell"><?php echo get_asset_tag_line($assetid); ?></td>
                        <?php
                            if ($write_access) {
                                ?><td class="sq-backend-table-cell"><?php echo check_box($prefix.'_reassign[]', $assetid); ?></td><?php
                            }
                        ?>
                    </tr>
                <?php
                    $roles_pointer++;
                }//end foreach
            }//end foreach
        }//end foreach

        if ($num_roles > $num_per_page) {
        ?>
            <tr>
                <td colspan="3" align="center" class="sq-backend-table-header">
                <?php
                hidden_field($prefix.$pag_id.'_start_at', $start_printing_at);
                if ($start_printing_at > 0) {
                    ?><a style="text-decoration: none;" href="#" onClick="Javascript: set_hidden_field('<?php echo $prefix.$pag_id; ?>_start_at', '<?php echo $start_printing_at - $num_per_page; ?>'); set_hidden_field('process_form', '0'); submit_form(); return false;"><?php
                } else {
                    ?><span style="color: #84848F"><?php
                }
                ?>
                &lt;&lt; <?php echo translate('previous_page');

                if ($start_printing_at > 0) {
                    echo '</a>';
                } else {
                    echo '</span>';
                }
                ?>
                &nbsp;<b><?php echo translate('page_number', (floor($start_printing_at / $num_per_page) + 1), ceil($num_roles / $num_per_page)); ?></b>&nbsp;

                <?php
                if (($start_printing_at + $num_per_page) < $num_roles) {
                    ?><a style="text-decoration: none;" href="#" onClick="Javascript: set_hidden_field('<?php echo $prefix.$pag_id; ?>_start_at', '<?php echo $start_printing_at + $num_per_page; ?>'); set_hidden_field('process_form', '0'); submit_form(); return false;"><?php
                } else {
                    ?><span style="color: #84848F"><?php
                }

                echo translate('next_page'); ?> &gt;&gt;
                <?php
                if (($start_printing_at + $num_per_page) < $num_roles) {
                    echo '</a>';
                } else {
                    echo '</span>';
                }
                ?>
                </td>
            </tr>
        <?php
        }//end if
        ?>
        </table>
        <?php

    }//end _printRoleTable()


    function paintRoles(&$asset, &$o, $prefix)
    {
        $write_access = $asset->adminAccess('roles');
        $string_code_suffix = ($asset instanceof User_Group) ? 'group' : 'user';

        $o->openSection(translate('role_directly_assigned_section_'.$string_code_suffix));
            $o->openRaw();

            if (SQ_CONF_ENABLE_ROLES_PERM_SYSTEM == '0' && SQ_CONF_ENABLE_ROLES_WF_SYSTEM == '0') {
                echo translate('roles_system_disabled');
            } else {
                $roles = $GLOBALS['SQ_SYSTEM']->am->getRole(NULL, NULL, $asset->id, TRUE, FALSE, FALSE, FALSE);
                if (empty($roles)) {
                    echo translate('no_roles_set');
                } else {
                    $this->_printRoleTable($prefix, 'direct', $roles, $write_access);
                    if ($write_access) {
                        echo translate('role_new_user').': ';
                        echo asset_finder($prefix.'_reassignee', 0, Array('user' => 'D', 'user_group' => 'D'));
                    }
                }
            }

            $o->closeRaw();
        $o->closeSection();

        $group_descendants = $GLOBALS['SQ_SYSTEM']->am->getTypeDescendants('user_group', TRUE);
        $group_descendants = array_diff($group_descendants, Array('role'));

        $parents = $GLOBALS['SQ_SYSTEM']->am->getParents($asset->id);

        $roles = Array();
        $parent_groups = Array();
        foreach ($parents as $assetid => $type_code) {
            if (in_array($type_code, $group_descendants)) {
                $roles += $GLOBALS['SQ_SYSTEM']->am->getRole(NULL, NULL, $assetid, TRUE, FALSE, FALSE, FALSE);
                $normal_role = $GLOBALS['SQ_SYSTEM']->am->getRole(NULL, NULL, $assetid, TRUE, FALSE, FALSE, FALSE);
                foreach ($normal_role as $roleid => $userids) {
                    foreach ($userids as $userid => $assetids) {
                        foreach ($assetids as $assetid) {
                            $roles[$roleid][$userid][] = $assetid;
                            $roles[$roleid][$userid] = array_unique($roles[$roleid][$userid]);
                        }
                    }
                }
            } else {
                $global_role = $GLOBALS['SQ_SYSTEM']->am->getRole(NULL, $assetid, 0, TRUE, FALSE, FALSE, FALSE);
                foreach ($global_role as $roleid => $userids) {
                    foreach ($userids[0] as $assetid) {
                        $roles[$roleid][$roleid][] = $assetid;
                        $roles[$roleid][$roleid] = array_unique($roles[$roleid][$roleid]);
                    }
                }
            }
        }

        if (!empty($roles)) {
            $o->openSection(translate('role_indirectly_assigned_section_'.$string_code_suffix));
                $o->openRaw();
                    $this->_printRoleTable($prefix, 'indirect', $roles, FALSE, TRUE);
                $o->closeRaw();
            $o->closeSection();
        }

        return $write_access;

    }//end paintRoles()


    function processRoles(&$asset, &$o, $prefix)
    {
        $reassignee = 0;
        if (isset($_REQUEST[$prefix.'_reassignee'])) {
            $reassignee = array_get_index($_REQUEST[$prefix.'_reassignee'], 'assetid', 0);
        }

        if (!$reassignee) return;

        $am = $GLOBALS['SQ_SYSTEM']->am;

        $roles = $GLOBALS['SQ_SYSTEM']->am->getRole(NULL, NULL, $asset->id, TRUE);
        $reassign_assetids = array_get_index($_REQUEST, $prefix.'_reassign', Array());

        $role_vars = Array();
        foreach ($roles as $roleid => $userids) {
            foreach ($userids as $userid => $assetids) {
                    $changes = array_intersect($reassign_assetids, $assetids);
                    if (!empty($changes)) {
                            $role_vars['add'][$roleid][] = $reassignee;
                            $role_vars['delete'][$roleid][] = $userid;
                    }
            }
        }

        if (!empty($reassign_assetids)) {
            $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();

            $vars = Array(
                        'assets'            => $am->getAssetInfo($reassign_assetids, Array(), FALSE, 'type_code'),
                        'role_changes'      => $role_vars,
                        'dependants_only'   => TRUE,
                    );

            $hh->queueHipo('hipo_job_edit_roles', $vars);
        }

        return TRUE;

    }//end processRoles()


}//end class

?>