/**
* Creates a new View for the given user, based on the given information
* about the view.
*
* Validation of the view data is performed, then the View is created. If
* the View is to be owned by a group, that group is given access to it.
*
* @param array $viewdata Data about the view. You can pass in most fields
* that appear in the view table.
*
* Note that you set who owns the View by setting
* either the owner, group or institution field as
* approriate.
*
* Currently, you cannot pass in access data. Use
* $view->set_access() after retrieving the $view
* object.
*
* @param int $userid The user who has issued the command to create the
* View (note: this is different from the "owner" of the
* View - a group or institution could be the "owner",
* but it's a _user_ who requests a View is created for it)
* @return View The created View
* @throws SystemException if the View data is invalid - mostly this is due
* to owner information being specified incorrectly.
*/
private static function _create(&$viewdata, $userid)
{
// If no owner information is provided, assume that the view is being
// created by the user for themself
if (!isset($viewdata['owner']) && !isset($viewdata['group']) && !isset($viewdata['institution'])) {
$viewdata['owner'] = $userid;
}
if (isset($viewdata['owner'])) {
if ($viewdata['owner'] != $userid) {
$userobj = new User();
$userobj->find_by_id($userid);
if (!$userobj->is_admin_for_user($viewdata['owner'])) {
throw new SystemException("View::_create: User {$userid} is not allowed to create a view for owner {$viewdata['owner']}");
}
}
// Users can only have one view of each non-portfolio type
if (isset($viewdata['type']) && $viewdata['type'] != 'portfolio' && get_record('view', 'owner', $viewdata['owner'], 'type', $viewdata['type'])) {
$viewdata['type'] = 'portfolio';
}
// Try to create the view with the owner's default theme if that theme is set by an
// institution (i.e. if it's different from the site theme)
//
// This needs to be modified if users are ever allowed to change their own theme
// preference. Currently it's okay because users' themes are forced on them by
// the site or institution default, but if some users are allowed to change their
// own theme pref, we should create those users' views without a theme.
if (!get_config('userscanchooseviewthemes') && !isset($viewdata['theme']) && (!isset($viewdata['type']) || $viewdata['type'] != 'dashboard')) {
global $USER;
if ($viewdata['owner'] == $USER->get('id')) {
$owner = $USER;
} else {
$owner = new User();
$owner->find_by_id($viewdata['owner']);
}
$ownerthemedata = $owner->get('institutiontheme');
$ownertheme = isset($ownerthemedata->basename) ? $ownerthemedata->basename : null;
if ($ownertheme && $ownertheme != get_config('theme') && $ownertheme != 'custom') {
$viewdata['theme'] = $ownertheme;
}
}
}
if (isset($viewdata['group'])) {
require_once 'group.php';
if (!group_user_can_edit_views($viewdata['group'], $userid)) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for group {$viewdata['group']}");
}
}
if (isset($viewdata['institution'])) {
$user = new User();
$user->find_by_id($userid);
if (!$user->can_edit_institution($viewdata['institution'])) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for institution {$viewdata['institution']}");
}
}
// Create the view
$defaultdata = array('numcolumns' => 2, 'numrows' => 1, 'columnsperrow' => self::default_columnsperrow(), 'template' => 0, 'type' => 'portfolio', 'title' => array_key_exists('title', $viewdata) ? $viewdata['title'] : self::new_title(get_string('Untitled', 'view'), (object) $viewdata), 'anonymise' => 0);
$data = (object) array_merge($defaultdata, $viewdata);
if ($data->type == 'portfolio' && (!isset($data->url) || is_null($data->url) || !strlen($data->url))) {
$data->urlid = generate_urlid($data->title, get_config('cleanurlviewdefault'), 3, 100);
$data->urlid = self::new_urlid($data->urlid, $data);
}
$view = new View(0, $data);
$view->commit();
if (isset($viewdata['group']) && (empty($viewdata['type']) || !empty($viewdata['type']) && $viewdata['type'] != 'grouphomepage')) {
require_once 'activity.php';
// Although group views are owned by the group, the view creator is treated as owner here.
// So we need to ignore them from the activity_occured email.
$beforeusers[$userid] = get_record('usr', 'id', $userid);
// By default, group views should be visible to the group
insert_record('view_access', (object) array('view' => $view->get('id'), 'group' => $viewdata['group'], 'ctime' => db_format_timestamp(time())));
// Notify group members
$accessdata = new StdClass();
$accessdata->view = $view->get('id');
$accessdata->oldusers = $beforeusers;
activity_occurred('viewaccess', $accessdata);
}
if (isset($viewdata['layout'])) {
// e.g. importing via LEAP2A
$layoutsrowscols = get_records_select_array('view_layout_rows_columns', 'viewlayout = ?', array($viewdata['layout']));
if ($layoutsrowscols) {
delete_records('view_rows_columns', 'view', $view->get('id'));
foreach ($layoutsrowscols as $layoutrow) {
insert_record('view_rows_columns', (object) array('view' => $view->get('id'), 'row' => $layoutrow->row, 'columns' => self::$layoutcolumns[$layoutrow->columns]->columns));
}
}
}
return new View($view->get('id'));
// Reread to ensure defaults are set
}
/**
* Given a view id, and a user id (defaults to currently logged in user if not
* specified) will return wether this user is allowed to look at this view.
*
* @param mixed $view viewid or View to check
* @param integer $user_id User trying to look at the view (defaults to
* currently logged in user, or null if user isn't logged in)
*
* @returns boolean Wether the specified user can look at the specified view.
*/
function can_view_view($view, $user_id = null)
{
global $USER, $SESSION;
if (defined('BULKEXPORT')) {
return true;
}
$now = time();
$dbnow = db_format_timestamp($now);
if ($user_id === null) {
$user = $USER;
$user_id = $USER->get('id');
} else {
$user = new User();
if ($user_id) {
try {
$user->find_by_id($user_id);
} catch (AuthUnknownUserException $e) {
}
}
}
$publicviews = get_config('allowpublicviews');
$publicprofiles = get_config('allowpublicprofiles');
// If the user is logged out and the publicviews & publicprofiles sitewide configs are false,
// we can deny access without having to hit the database at all
if (!$user_id && !$publicviews && !$publicprofiles) {
return false;
}
require_once get_config('libroot') . 'view.php';
if ($view instanceof View) {
$view_id = $view->get('id');
} else {
$view = new View($view_id = $view);
}
// If the page belongs to an individual, check for individual-specific overrides
if ($view->get('owner')) {
$ownerobj = $view->get_owner_object();
// Suspended user
if ($ownerobj->suspendedctime) {
return false;
}
// Probationary user (no public pages or profiles)
// (setting these here instead of doing a return-false, so that we can do checks for
// logged-in users later)
require_once get_config('libroot') . 'antispam.php';
$onprobation = is_probationary_user($ownerobj->id);
$publicviews = $publicviews && !$onprobation;
$publicprofiles = $publicprofiles && !$onprobation;
// Member of an institution that prohibits public pages
// (group views and logged in users are not affected by
// the institution level config for public views)
$owner = new User();
$owner->find_by_id($ownerobj->id);
$publicviews = $publicviews && $owner->institution_allows_public_views();
}
// Now that we've examined the page owner, check again for whether it can be viewed by a logged-out user
if (!$user_id && !$publicviews && !$publicprofiles) {
return false;
}
if ($user_id && $user->can_edit_view($view)) {
return true;
}
// If the view's owner is suspended, deny access to the view
if ($view->get('owner')) {
if (!($owner = $view->get_owner_object()) || $owner->suspendedctime) {
return false;
}
}
if ($SESSION->get('mnetuser')) {
$mnettoken = get_cookie('mviewaccess:' . $view_id);
}
// If the page has been marked "objectionable" admins should be able to view
// it for review purposes.
if ($view->is_objectionable()) {
if ($owner = $view->get('owner')) {
if ($user->is_admin_for_user($owner)) {
return true;
}
} else {
if ($view->get('group') && $user->get('admin')) {
return true;
}
}
}
// Overriding start/stop dates are set by the owner to deny access
// to users who would otherwise be allowed to see the view. However,
// for some kinds of access (e.g. objectionable content, submitted
// views), we have to override the override and let the logged in
// user see it anyway. So we can't return false now, we have to wait
// till we find out what kind of view_access record is being used.
$overridestart = $view->get('startdate');
$overridestop = $view->get('stopdate');
$allowedbyoverride = (empty($overridestart) || $overridestart < $dbnow) && (empty($overridestop) || $overridestop > $dbnow);
$access = View::user_access_records($view_id, $user_id);
if (empty($access)) {
return false;
}
foreach ($access as &$a) {
if ($a->accesstype == 'public' && $allowedbyoverride) {
if ($publicviews) {
return true;
} else {
if ($publicprofiles && $view->get('type') == 'profile') {
return true;
}
}
} else {
if ($a->token && ($allowedbyoverride || !$a->visible)) {
$usertoken = get_cookie('viewaccess:' . $view_id);
if ($a->token == $usertoken && $publicviews) {
return true;
}
if (!empty($mnettoken) && $a->token == $mnettoken) {
$mnetviewlist = $SESSION->get('mnetviewaccess');
if (empty($mnetviewlist)) {
$mnetviewlist = array();
}
$mnetviewlist[$view_id] = true;
$SESSION->set('mnetviewaccess', $mnetviewlist);
return true;
}
// Don't bother to pull the collection out unless the user actually
// has some collection access cookies.
if ($ctokens = get_cookies('caccess:')) {
$cid = $view->collection_id();
if ($cid && isset($ctokens[$cid]) && $a->token == $ctokens[$cid]) {
return true;
}
}
} else {
if ($user_id) {
if ($a->accesstype == 'friends') {
$owner = $view->get('owner');
if (!get_field_sql('
SELECT COUNT(*) FROM {usr_friend} f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)', array($owner, $user_id, $user_id, $owner))) {
continue;
}
} else {
if ($a->institution) {
// Check if user belongs to the allowed institution
if (!in_array($a->institution, array_keys($user->get('institutions')))) {
continue;
}
}
}
if (!$allowedbyoverride && $a->visible) {
continue;
}
// The view must have loggedin access, user access for the user
// or group/role access for one of the user's groups
return true;
}
}
}
}
return false;
}
/**
* Creates a new View for the given user, based on the given information
* about the view.
*
* Validation of the view data is performed, then the View is created. If
* the View is to be owned by a group, that group is given access to it.
*
* @param array $viewdata Data about the view. You can pass in most fields
* that appear in the view table.
*
* Note that you set who owns the View by setting
* either the owner, group or institution field as
* approriate.
*
* Currently, you cannot pass in access data. Use
* $view->set_access() after retrieving the $view
* object.
*
* @param int $userid The user who has issued the command to create the
* View (note: this is different from the "owner" of the
* View - a group or institution could be the "owner",
* but it's a _user_ who requests a View is created for it)
* @return View The created View
* @throws SystemException if the View data is invalid - mostly this is due
* to owner information being specified incorrectly.
*/
private static function _create(&$viewdata, $userid)
{
// If no owner information is provided, assume that the view is being
// created by the user for themself
if (!isset($viewdata['owner']) && !isset($viewdata['group']) && !isset($viewdata['institution'])) {
$viewdata['owner'] = $userid;
}
if (isset($viewdata['owner'])) {
if ($viewdata['owner'] != $userid) {
$userobj = new User();
$userobj->find_by_id($userid);
if (!$userobj->is_admin_for_user($viewdata['owner'])) {
throw new SystemException("View::_create: User {$userid} is not allowed to create a view for owner {$viewdata['owner']}");
}
}
// Users can only have one view of each non-portfolio type
if (isset($viewdata['type']) && $viewdata['type'] != 'portfolio' && get_record('view', 'owner', $viewdata['owner'], 'type', $viewdata['type'])) {
$viewdata['type'] = 'portfolio';
}
// Try to create the view with the owner's default theme if that theme is set by an
// institution (i.e. if it's different from the site theme)
//
// This needs to be modified if users are ever allowed to change their own theme
// preference. Currently it's okay because users' themes are forced on them by
// the site or institution default, but if some users are allowed to change their
// own theme pref, we should create those users' views without a theme.
if (!get_config('userscanchooseviewthemes') && !isset($viewdata['theme']) && (!isset($viewdata['type']) || $viewdata['type'] != 'dashboard')) {
global $USER;
if ($viewdata['owner'] == $USER->get('id')) {
$owner = $USER;
} else {
$owner = new User();
$owner->find_by_id($viewdata['owner']);
}
$ownertheme = $owner->get('theme');
if ($ownertheme && $ownertheme != get_config('theme')) {
$viewdata['theme'] = $ownertheme;
}
}
}
if (isset($viewdata['group'])) {
require_once 'group.php';
if (!group_user_can_edit_views($viewdata['group'], $userid)) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for group {$viewdata['group']}");
}
}
if (isset($viewdata['institution'])) {
$user = new User();
$user->find_by_id($userid);
if (!$user->can_edit_institution($viewdata['institution'])) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for institution {$viewdata['institution']}");
}
}
// Create the view
$defaultdata = array('numcolumns' => 3, 'template' => 0, 'type' => 'portfolio', 'title' => self::new_title(get_string('Untitled', 'view'), (object) $viewdata));
$data = (object) array_merge($defaultdata, $viewdata);
$view = new View(0, $data);
$view->commit();
if (isset($viewdata['group'])) {
// By default, group views should be visible to the group
insert_record('view_access', (object) array('view' => $view->get('id'), 'group' => $viewdata['group']));
}
return new View($view->get('id'));
// Reread to ensure defaults are set
}
/**
* Creates a new View for the given user, based on the given information
* about the view.
*
* Validation of the view data is performed, then the View is created. If
* the View is to be owned by a group, that group is given access to it.
*
* @param array $viewdata Data about the view. You can pass in most fields
* that appear in the view table.
*
* Note that you set who owns the View by setting
* either the owner, group or institution field as
* approriate.
*
* Currently, you cannot pass in access data. Use
* $view->set_access() after retrieving the $view
* object.
*
* @param int $userid The user who has issued the command to create the
* View (note: this is different from the "owner" of the
* View - a group or institution could be the "owner",
* but it's a _user_ who requests a View is created for it)
* @return View The created View
* @throws SystemException if the View data is invalid - mostly this is due
* to owner information being specified incorrectly.
*/
private static function _create(&$viewdata, $userid)
{
// If no owner information is provided, assume that the view is being
// created by the user for themself
if (!isset($viewdata['owner']) && !isset($viewdata['group']) && !isset($viewdata['institution'])) {
$viewdata['owner'] = $userid;
}
if (isset($viewdata['owner'])) {
if ($viewdata['owner'] != $userid) {
$userobj = new User();
$userobj->find_by_id($userid);
if (!$userobj->is_admin_for_user($viewdata['owner'])) {
throw new SystemException("View::_create: User {$userid} is not allowed to create a view for owner {$viewdata['owner']}");
}
}
}
if (isset($viewdata['group'])) {
require_once 'group.php';
if (!group_user_can_edit_views($viewdata['group'], $userid)) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for group {$viewdata['group']}");
}
}
if (isset($viewdata['institution'])) {
$user = new User();
$user->find_by_id($userid);
if (!$user->can_edit_institution($viewdata['institution'])) {
throw new SystemException("View::_create: User {$userid} is not permitted to create a view for institution {$viewdata['institution']}");
}
}
// Create the view
$defaultdata = array('numcolumns' => 3, 'template' => 0, 'type' => 'portfolio', 'title' => self::new_title(get_string('Untitled', 'view'), (object) $viewdata));
$data = (object) array_merge($defaultdata, $viewdata);
$view = new View(0, $data);
$view->commit();
if (isset($viewdata['group'])) {
// By default, group views should be visible to the group
$view->set_access(array(array('type' => 'group', 'id' => $viewdata['group'], 'startdate' => null, 'stopdate' => null, 'role' => null)));
}
return $view;
}
/**
* Given a view id, and a user id (defaults to currently logged in user if not
* specified) will return wether this user is allowed to look at this view.
*
* @param mixed $view viewid or View to check
* @param integer $user_id User trying to look at the view (defaults to
* currently logged in user, or null if user isn't logged in)
*
* @returns boolean Wether the specified user can look at the specified view.
*/
function can_view_view($view, $user_id = null)
{
global $USER, $SESSION;
if (defined('BULKEXPORT')) {
return true;
}
$now = time();
$dbnow = db_format_timestamp($now);
if ($user_id === null) {
$user = $USER;
$user_id = $USER->get('id');
} else {
$user = new User();
if ($user_id) {
try {
$user->find_by_id($user_id);
} catch (AuthUnknownUserException $e) {
}
}
}
$publicviews = get_config('allowpublicviews');
$publicprofiles = get_config('allowpublicprofiles');
// OVERWRITE 1: deletion
//if (!$user_id && !$publicviews && !$publicprofiles) {
// return false;
//}
// END OVERWRITE 1
if (!class_exists('View')) {
require_once get_config('libroot') . 'view.php';
}
if ($view instanceof View) {
$view_id = $view->get('id');
} else {
$view = new View($view_id = $view);
}
// group views and logged in users are not affected by
// the institution level config for public views
if (empty($user_id) && ($ownerobj = $view->get_owner_object())) {
$owner = new User();
$owner->find_by_id($ownerobj->id);
if (!$owner->institution_allows_public_views()) {
return false;
}
}
if ($user_id && $user->can_edit_view($view)) {
return true;
}
$access = View::user_access_records($view_id, $user_id);
if (empty($access)) {
return false;
}
// If the view's owner is suspended, deny access to the view
if ($view->get('owner')) {
if (!($owner = $view->get_owner_object()) || $owner->suspendedctime) {
return false;
}
}
// Overriding start/stop dates are set by the owner to deny access
// to users who would otherwise be allowed to see the view. However,
// for some kinds of access (e.g. objectionable content, submitted
// views), we have to override the override and let the logged in
// user see it anyway. So we can't return false now, we have to wait
// till we find out what kind of view_access record is being used.
$overridestart = $view->get('startdate');
$overridestop = $view->get('stopdate');
$allowedbyoverride = (empty($overridestart) || $overridestart < $dbnow) && (empty($overridestop) || $overridestop > $dbnow);
if ($SESSION->get('mnetuser')) {
$mnettoken = get_cookie('mviewaccess:' . $view_id);
}
foreach ($access as &$a) {
if ($a->accesstype == 'public' && $allowedbyoverride) {
if ($publicviews) {
return true;
} else {
if ($publicprofiles && $view->get('type') == 'profile') {
return true;
}
}
} else {
if ($a->token && ($allowedbyoverride || !$a->visible)) {
$usertoken = get_cookie('viewaccess:' . $view_id);
// OVERWRITE 2: replacement, changed from:
//if ($a->token == $usertoken && $publicviews) {
// return true;
//}
// to:
if ($a->token == $usertoken) {
if (!$publicviews) {
global $CFG;
$mhr_view = $CFG->current_app->selectFromMhrTable('view', 'id', $view_id, true);
if ($mhr_view) {
if (!isset($mhr_view->institution) || $mhr_view->institution == '') {
return false;
}
}
}
return true;
}
// END OVERWRITE 2
if (!empty($mnettoken) && $a->token == $mnettoken) {
$mnetviewlist = $SESSION->get('mnetviewaccess');
if (empty($mnetviewlist)) {
$mnetviewlist = array();
}
$mnetviewlist[$view_id] = true;
$SESSION->set('mnetviewaccess', $mnetviewlist);
return true;
}
// Don't bother to pull the collection out unless the user actually
// has some collection access cookies.
if ($ctokens = get_cookies('caccess:')) {
$cid = $view->collection_id();
if ($cid && isset($ctokens[$cid]) && $a->token == $ctokens[$cid]) {
return true;
}
}
} else {
if ($user_id) {
if ($a->accesstype == 'friends') {
$owner = $view->get('owner');
if (!get_field_sql('
SELECT COUNT(*) FROM {usr_friend} f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)', array($owner, $user_id, $user_id, $owner))) {
continue;
}
} else {
if ($a->institution) {
// Check if user belongs to the allowed institution
if (!in_array($a->institution, array_keys($user->get('institutions')))) {
continue;
}
} else {
if ($a->accesstype == 'objectionable') {
if ($owner = $view->get('owner')) {
if ($user->is_admin_for_user($owner)) {
return true;
}
} else {
if ($view->get('group') && $user->get('admin')) {
return true;
}
}
continue;
}
}
}
if (!$allowedbyoverride && $a->visible) {
continue;
}
// The view must have loggedin access, user access for the user
// or group/role access for one of the user's groups
return true;
}
}
}
}
return false;
}
/**
* Given a view id, and a user id (defaults to currently logged in user if not
* specified) will return wether this user is allowed to look at this view.
*
* @param integer $view_id View ID to check
* @param integer $user_id User trying to look at the view (defaults to
* currently logged in user, or null if user isn't logged in)
*
* @returns boolean Wether the specified user can look at the specified view.
*/
function can_view_view($view_id, $user_id = null)
{
global $USER, $SESSION;
if (defined('BULKEXPORT')) {
return true;
}
$now = time();
$dbnow = db_format_timestamp($now);
if ($user_id === null) {
$user = $USER;
$user_id = $USER->get('id');
} else {
$user = new User();
if ($user_id) {
try {
$user->find_by_id($user_id);
} catch (AuthUnknownUserException $e) {
}
}
}
$publicviews = get_config('allowpublicviews');
$publicprofiles = get_config('allowpublicprofiles');
if (!$user_id && !$publicviews && !$publicprofiles) {
return false;
}
require_once get_config('libroot') . 'view.php';
$view = new View($view_id);
if ($user_id && $user->can_edit_view($view)) {
return true;
}
$access = View::user_access_records($view_id, $user_id);
if (empty($access)) {
return false;
}
if ($SESSION->get('mnetuser')) {
$mnettoken = get_cookie('mviewaccess:' . $view_id);
}
foreach ($access as &$a) {
if ($a->accesstype == 'public') {
if ($publicviews) {
return true;
} else {
if ($publicprofiles && $view->get('type') == 'profile') {
return true;
}
}
} else {
if ($a->token) {
$usertoken = get_cookie('viewaccess:' . $view_id);
if ($a->token == $usertoken && $publicviews) {
return true;
}
if (!empty($mnettoken) && $a->token == $mnettoken) {
$mnetviewlist = $SESSION->get('mnetviewaccess');
if (empty($mnetviewlist)) {
$mnetviewlist = array();
}
$mnetviewlist[$view_id] = true;
$SESSION->set('mnetviewaccess', $mnetviewlist);
return true;
}
// Don't bother to pull the collection out unless the user actually
// has some collection access cookies.
if ($ctokens = get_cookies('caccess:')) {
$cid = $view->collection_id();
if ($cid && isset($ctokens[$cid]) && $a->token == $ctokens[$cid]) {
return true;
}
}
} else {
if ($user_id) {
if ($a->accesstype == 'friends') {
$owner = $view->get('owner');
if (!get_field_sql('
SELECT COUNT(*) FROM {usr_friend} f WHERE (usr1=? AND usr2=?) OR (usr1=? AND usr2=?)', array($owner, $user_id, $user_id, $owner))) {
continue;
}
} else {
if ($a->accesstype == 'objectionable') {
if ($owner = $view->get('owner')) {
if ($user->is_admin_for_user($owner)) {
return true;
}
} else {
if ($view->get('group') && $user->get('admin')) {
return true;
}
}
continue;
}
}
// The view must have loggedin access, user access for the user
// or group/role access for one of the user's groups
return true;
}
}
}
}
return false;
}
