.
*
* @package mahara
* @subpackage core
* @author Catalyst IT Ltd
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL
* @copyright (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
* @copyright (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
*/
defined('INTERNAL') || die();
/**
* work around silly php settings
* and broken setup stuff about the install
* and raise a warning/fail depending on severity
*/
function ensure_sanity() {
// PHP version
if (version_compare(phpversion(), '5.1.3') < 0) {
throw new ConfigSanityException(get_string('phpversion', 'error'));
}
// Various required extensions
if (!extension_loaded('json')) {
throw new ConfigSanityException(get_string('jsonextensionnotloaded', 'error'));
}
switch (get_config('dbtype')) {
case 'postgres8':
if (!extension_loaded('pgsql')) {
throw new ConfigSanityException(get_string('pgsqldbextensionnotloaded', 'error'));
}
break;
case 'mysql5':
if (!extension_loaded('mysql')) {
throw new ConfigSanityException(get_string('mysqldbextensionnotloaded', 'error'));
}
break;
default:
throw new ConfigSanityException(get_string('unknowndbtype', 'error'));
}
if (!extension_loaded('xml')) {
throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'xml'));
}
if (!extension_loaded('libxml')) {
throw new ConfigSanityException(get_string('xmlextensionnotloaded', 'error', 'libxml'));
}
if (!extension_loaded('gd')) {
throw new ConfigSanityException(get_string('gdextensionnotloaded', 'error'));
}
if (!extension_loaded('session')) {
throw new ConfigSanityException(get_string('sessionextensionnotloaded', 'error'));
}
if(!extension_loaded('curl')) {
throw new ConfigSanityException(get_string('curllibrarynotinstalled', 'error'));
}
if (!extension_loaded('dom')) {
throw new ConfigSanityException(get_string('domextensionnotloaded', 'error'));
}
//Check for freetype in the gd extension
$gd_info = gd_info();
if (!$gd_info['FreeType Support']) {
throw new ConfigSanityException(get_string('gdfreetypenotloaded', 'error'));
}
// register globals workaround
if (ini_get_bool('register_globals')) {
log_environ(get_string('registerglobals', 'error'));
$massivearray = array_keys(array_merge($_POST, $_GET, $_COOKIE, $_SERVER, $_REQUEST, $_FILES));
foreach ($massivearray as $tounset) {
unset($GLOBALS[$tounset]);
}
}
// magic_quotes_gpc workaround
if (!defined('CRON') && ini_get_bool('magic_quotes_gpc')) {
log_environ(get_string('magicquotesgpc', 'error'));
function stripslashes_deep($value) {
$value = is_array($value) ?
array_map('stripslashes_deep', $value) :
stripslashes($value);
return $value;
}
$_POST = array_map('stripslashes_deep', $_POST);
$_GET = array_map('stripslashes_deep', $_GET);
$_COOKIE = array_map('stripslashes_deep', $_COOKIE);
$_REQUEST = array_map('stripslashes_deep', $_REQUEST);
$servervars = array('REQUEST_URI','QUERY_STRING','HTTP_REFERER','PATH_INFO','PHP_SELF','PATH_TRANSLATED');
foreach ($servervars as $tocheck) {
if (array_key_exists($tocheck,$_SERVER) && !empty($_SERVER[$tocheck])) {
$_SERVER[$tocheck] = stripslashes($_SERVER[$tocheck]);
}
}
}
if (ini_get_bool('magic_quotes_runtime')) {
// Turn of magic_quotes_runtime. Anyone with this on deserves a slap in the face
set_magic_quotes_runtime(0);
log_environ(get_string('magicquotesruntime', 'error'));
}
if (ini_get_bool('magic_quotes_sybase')) {
// See above comment re. magic_quotes_runtime
@ini_set('magic_quotes_sybase', 0);
log_environ(get_string('magicquotessybase', 'error'));
}
if (ini_get_bool('safe_mode')) {
// We don't run with safe mode
throw new ConfigSanityException(get_string('safemodeon', 'error'));
}
// Other things that might be worth checking:
// memory limit
// file_uploads (off|on)
// upload_max_filesize
// allow_url_fopen (only if we use this)
//
// dataroot inside document root.
if (strpos(get_config('dataroot'), get_config('docroot')) !== false) {
throw new ConfigSanityException(get_string('datarootinsidedocroot', 'error'));
}
// dataroot not writable..
if (!check_dir_exists(get_config('dataroot')) || !is_writable(get_config('dataroot'))) {
throw new ConfigSanityException(get_string('datarootnotwritable', 'error', get_config('dataroot')));
}
if (
!check_dir_exists(get_config('dataroot') . 'smarty/compile') ||
!check_dir_exists(get_config('dataroot') . 'smarty/cache') ||
!check_dir_exists(get_config('dataroot') . 'sessions') ||
!check_dir_exists(get_config('dataroot') . 'temp') ||
!check_dir_exists(get_config('dataroot') . 'langpacks') ||
!check_dir_exists(get_config('dataroot') . 'htmlpurifier')) {
throw new ConfigSanityException(get_string('couldnotmakedatadirectories', 'error'));
}
raise_memory_limit('128M');
}
/**
* Check sanity of things that we only check at installation time - not on
* every request, like ensure_sanity() does
*/
function ensure_install_sanity() {
// Must must must be a UTF8 database!
if (!db_is_utf8()) {
throw new ConfigSanityException(get_string('dbnotutf8', 'error'));
}
}
function ensure_upgrade_sanity() {
// Check column collation is equal to the default
if (is_mysql()) {
require_once('ddl.php');
if (table_exists(new XMLDBTable('event_type'))) {
if (!column_collation_is_default('event_type', 'name')) {
throw new ConfigSanityException(get_string('dbcollationmismatch', 'admin'));
}
}
}
}
/**
* Check to see if the internal plugins are installed. Die if they are not.
*/
function ensure_internal_plugins_exist() {
// Internal things installed
if (get_config('installed')) {
foreach (plugin_types() as $type) {
if (!record_exists($type . '_installed', 'name', 'internal')) {
throw new ConfigSanityException(get_string($type . 'notinstalled'));
}
}
}
}
function get_string($identifier, $section='mahara') {
$variables = func_get_args();
if (count($variables) > 2) { // we have some stuff we need to sprintf
array_shift($variables);
array_shift($variables); //shift off the first two.
}
else {
$variables = array();
}
return get_string_location($identifier, $section, $variables);
}
function get_string_from_language($lang, $identifier, $section='mahara') {
$variables = func_get_args();
if (count($variables) > 3) { // we have some stuff we need to sprintf
array_shift($variables);
array_shift($variables);
array_shift($variables); //shift off the first three.
}
else {
$variables = array();
}
return get_string_location($identifier, $section, $variables, 'format_langstring', $lang);
}
function get_helpfile($plugintype, $pluginname, $form, $element, $page=null, $section=null) {
if ($langfile = get_helpfile_location($plugintype, $pluginname, $form, $element, $page, $section)) {
return file_get_contents($langfile);
}
return false;
}
function get_helpfile_location($plugintype, $pluginname, $form, $element, $page=null, $section=null) {
$subdir = 'help/';
if ($page) {
$pagebits = split('-', $page);
$file = array_pop($pagebits) . '.html';
if ($plugintype != 'core') {
$subdir .= 'pages/' . join('/', $pagebits) . '/';
}
else {
$subdir .= 'pages/' . $pluginname . '/' . join('/', $pagebits) . '/';
}
}
else if ($section) {
$subdir .= 'sections/';
$file = $section . '.html';
}
else if (!empty($form) && !empty($element)) {
$subdir .= 'forms/';
$file = $form . '.' . $element . '.html';
}
else if (!empty($form) && empty($element)) {
$subdir .= 'forms/';
$file = $form . '.html';
}
else {
return false;
}
// now we have to try and locate the help file
$lang = current_language();
if ($lang == 'en.utf8') {
$trieden = true;
}
else {
$trieden = false;
}
//try the local settings
$langfile = get_config('docroot') . 'local/lang/' . $lang . '/' . $subdir;
if ($plugintype != 'core') {
$langfile .= $plugintype . '.' . $pluginname . '.' . $file;
}
else {
$langfile .= $file;
}
if (is_readable($langfile)) {
return $langfile;
}
if ($plugintype != 'core') {
$location = $plugintype . '/' . $pluginname . '/lang/';
}
else {
$location = 'lang/';
}
// try the current language
$langfile = get_language_root() . $location . $lang . '/' . $subdir . $file;
if (is_readable($langfile)) {
return $langfile;
}
// if it's not found, try the parent language if there is one...
if (empty($data) && empty($trieden)) {
$langfile = get_language_root($lang) . 'lang/' . $lang . '/langconfig.php';
if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
if ($parentlang == 'en.utf8') {
$trieden = true;
}
$langfile = get_language_root($parentlang) . $location . $parentlang . '/' . $subdir . $file;
if (is_readable($langfile)) {
return $langfile;
}
}
}
// if it's STILL not found, and we haven't already tried english ...
if (empty($data) && empty($trieden)) {
$langfile = get_language_root('en.utf8') . $location . 'en.utf8/' . $subdir . $file;
if (is_readable($langfile)) {
return $langfile;
}
}
return false;
}
// get a string without sprintfing it.
function get_raw_string($identifier, $section='mahara') {
// For a raw string we don't want to format any arguments using
// sprintf, so the replace function passed to get_string_location
// should just return the first argument and ignore the second.
return get_string_location($identifier, $section, array(),
create_function('$string, $args','return $string;'));
}
/**
* This function gets a language string identified by $identifier from
* an appropriate location, and formats the string and any arguments
* in $variables using the function $replacefunc.
*
* @param string $identifier
* @param string $section
* @param array $variables
* @param function $replacefunc
* @return string
*/
function get_string_location($identifier, $section, $variables, $replacefunc='format_langstring', $lang='') {
$langconfigstrs = array('parentlanguage', 'thislanguage');
if ($section == 'mahara' &&
(in_array($identifier, $langconfigstrs)
|| strpos($identifier, 'strftime') === 0
|| strpos($identifier, 'strfday') === 0)) {
$section = 'langconfig';
}
if (empty($lang)) {
$lang = current_language();
}
// Define the locations of language strings for this section
$langstringroot = get_language_root($lang);
$langdirectory = ''; // The directory in which the language file for this string should ideally reside, if the language has implemented it
if (false === strpos($section, '.')) {
$langdirectory = 'lang/';
}
else {
$extras = plugin_types(); // more later..
foreach ($extras as $tocheck) {
if (strpos($section, $tocheck . '.') === 0) {
$pluginname = substr($section ,strlen($tocheck) + 1);
if ($tocheck == 'blocktype' &&
strpos($pluginname, '/') !== false) { // it belongs to an artefact plugin
$bits = explode('/', $pluginname);
$langdirectory = 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/lang/';
$section = 'blocktype.' . $bits[1];
}
else {
$langdirectory = $tocheck . '/' . $pluginname . '/lang/';
}
}
}
}
// First check all the normal locations for the string in the current language
if ($result = get_string_local($langstringroot . $langdirectory, $lang . '/' . $section . '.php', $identifier)) {
return $replacefunc($result, $variables);
}
// If the preferred language was English (utf8) we can abort now
// saving some checks beacuse it's the only "root" lang
if ($lang == 'en.utf8') {
return '[[' . $identifier . '/' . $section . ']]';
}
// Is a parent language defined? If so, try to find this string in a parent language file
$langfile = $langstringroot . 'lang/' . $lang . '/langconfig.php';
if (is_readable($langfile)) {
if ($parentlang = get_string_from_file('parentlanguage', $langfile)) {
if ($result = get_string_local(get_language_root($parentlang) . 'lang/', $parentlang . '/' . $section . '.php', $identifier)) {
return $replacefunc($result, $variables);
}
}
}
/// Our only remaining option is to try English
if ($result = get_string_local(get_config('docroot') . $langdirectory, 'en.utf8/' . $section . '.php', $identifier)) {
return $replacefunc($result, $variables);
}
return '[[' . $identifier . '/' . $section . ']]'; // Last resort
}
/**
* Get string from a file, checking the appropriate local customisation directory first
*
*/
function get_string_local($langpath, $langfile, $identifier) {
foreach (array(get_config('docroot') . 'local/lang/', $langpath) as $dir) {
$file = $dir . $langfile;
if (is_readable($file)) {
if ($result = get_string_from_file($identifier, $file)) {
return $result;
}
}
}
return false;
}
/**
* Return a list of available languages
*
*/
function get_languages() {
static $langs = array();
if (!$langs) {
foreach (language_get_searchpaths() as $searchpath) {
$langbase = $searchpath . 'lang/';
if ($langdir = @opendir($langbase)) {
while (false !== ($subdir = readdir($langdir))) {
if (preg_match('/\.utf8$/', $subdir) && is_dir($langbase . $subdir)) {
$langfile = $langbase . $subdir . '/langconfig.php';
if (is_readable($langfile)) {
if ($langname = get_string_from_file('thislanguage', $langfile)) {
$langs[$subdir] = $langname;
}
}
}
}
closedir($langdir);
}
else {
log_warn('Unable to read language directory ' . $langbase);
}
}
}
return $langs;
}
/**
* Returns whether the given language is installed/available for use
*/
function language_installed($lang) {
foreach (language_get_searchpaths() as $searchpath) {
if (is_readable($searchpath . 'lang/' . $lang . '/langconfig.php')) {
return true;
}
}
return false;
}
/**
* Returns a list of directories in which to search for language packs.
*
* This is influenced by the configuration variable 'langpacksearchpaths'
*/
function language_get_searchpaths() {
static $searchpaths = array();
if (!$searchpaths) {
// Construct the search path
$docrootpath = array(get_config('docroot'));
// Paths to language files in dataroot
$datarootpaths = (array)glob(get_config('dataroot') . 'langpacks/*.utf8', GLOB_MARK | GLOB_ONLYDIR);
// langpacksearchpaths configuration variable - for experts :)
$lpsearchpaths = (array)get_config('langpacksearchpaths');
$langpacksearchpaths = array();
foreach ($lpsearchpaths as $path) {
if (is_dir($path)) {
$langpacksearchpaths[] = (substr($path, -1) == '/') ? $path : "$path/";
}
else {
log_warn("Path in langpacksearchpaths is not a directory: $path");
}
}
$searchpaths = array_merge($docrootpath, $datarootpaths, $langpacksearchpaths);
}
return $searchpaths;
}
/**
* Get the directory in which the specified language pack resides.
*
* Defaults to getting the directory for the current_language() - i.e. the
* language the user is using
*
* Returns null if the language can't be found
*
* @param string $language The language to look for
*/
function get_language_root($language=null) {
static $language_root_cache = array();
if (!isset($language_root_cache[$language])) {
if ($language == null) {
$language = current_language();
}
foreach (language_get_searchpaths() as $path) {
if (is_dir("$path/lang/$language")) {
return $language_root_cache[$language] = $path;
}
}
// Oh noes, can't be found
$language_root_cache[$language] = null;
}
return $language_root_cache[$language];
}
/**
* Return a list of all available themes.
* @return array subdir => name
*/
function get_all_themes() {
static $themes = null;
if (is_null($themes)) {
$themes = array();
$themelist = get_all_theme_objects();
foreach ($themelist AS $subdir => $theme) {
$themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
}
}
return $themes;
}
/**
* Return a list of themes available to this user
* If the user is a member of any institutions, only themes available to
* those institutions are returned; or
* If a user is not a member of any institution, all themes not marked as
* institution specific are returned.
* @return array subdir => name
*/
function get_user_accessible_themes() {
global $USER;
$themes = array();
if ($institutions = $USER->get('institutions')) {
// Get themes for all of this users institutions
foreach ($institutions AS $i) {
$themes = array_merge($themes, get_institution_themes($i->institution));
}
}
else {
$themelist = get_all_theme_objects();
foreach ($themelist AS $subdir => $theme) {
if (!isset($theme->institutions) || !is_array($theme->institutions)) {
$themes[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
}
}
}
return $themes;
}
/**
* Return a list of themes available to the specified institution
* @param string institution the name of the institution to load themes for
* @return array subdir => name
* @throws SystemException if unable to read the theme directory
*/
function get_institution_themes($institution) {
static $institutionthemes = array();
if (!isset($institutionthemes[$institution])) {
$themes = get_all_theme_objects();
$r = array();
foreach ($themes AS $subdir => $theme) {
if (empty($theme->institutions) || !is_array($theme->institutions) || in_array($institution, $theme->institutions)) {
$r[$subdir] = isset($theme->displayname) ? $theme->displayname : $subdir;
}
}
$institutionthemes[$institution] = $r;
}
return $institutionthemes[$institution];
}
/**
* Return a list of all themes available on the system
* @return array An array of theme objects
* @throws SystemException if unable to read the theme directory
*/
function get_all_theme_objects() {
static $themes = null;
if (is_null($themes)) {
$themes = array();
$themebase = get_config('docroot') . 'theme/';
if (!$themedir = opendir($themebase)) {
throw new SystemException('Unable to read theme directory '.$themebase);
}
while (false !== ($subdir = readdir($themedir))) {
if ($subdir != "." && $subdir != ".." && is_dir($themebase . $subdir)) {
$config_path = $themebase . $subdir . '/themeconfig.php';
if (is_readable($config_path)) {
require($config_path);
if (empty($theme->disabled) || !$theme->disabled) {
$themes[$subdir] = $theme;
}
}
}
}
closedir($themedir);
}
return $themes;
}
/**
* This function is only used from {@link get_string()}.
*
* @internal Only used from get_string, not meant to be public API
* @param string $identifier ?
* @param string $langfile ?
* @param string $destination ?
* @return string|false ?
* @staticvar array $strings Localized strings
* @access private
* @todo Finish documenting this function.
*/
function get_string_from_file($identifier, $langfile) {
static $strings; // Keep the strings cached in memory.
if (empty($strings[$langfile])) {
$string = array();
include ($langfile);
$strings[$langfile] = $string;
} else {
$string = &$strings[$langfile];
}
if (!isset ($string[$identifier])) {
return false;
}
return $string[$identifier];
}
/**
* This function makes the return value of ini_get consistent if you are
* setting server directives through the .htaccess file in apache.
* Current behavior for value set from php.ini On = 1, Off = [blank]
* Current behavior for value set from .htaccess On = On, Off = Off
* Contributed by jdell @ unr.edu
*
* @param string $ini_get_arg setting to look for
* @return bool
*/
function ini_get_bool($ini_get_arg) {
$temp = ini_get($ini_get_arg);
if ($temp == '1' or strtolower($temp) == 'on') {
return true;
}
return false;
}
/**
* This function loads up the basic $CFG
* from the database table
* note that it doesn't load plugin config
* as not every page needs them
* @return boolean false if the assignment fails (generally if the databse is not installed)
*/
function load_config() {
global $CFG;
$dbconfig = get_records_array('config', '', '', '', 'field, value');
foreach ($dbconfig as $cfg) {
if (isset($CFG->{$cfg->field}) && $CFG->{$cfg->field} != $cfg->value) {
// @todo warn that we're overriding db config with $CFG
continue;
}
$CFG->{$cfg->field} = $cfg->value;
}
return true;
}
/**
* This function returns a value from $CFG
* or null if it is not found
*
* @param string $key config setting to look for
* @return mixed
*/
function get_config($key) {
global $CFG;
if (isset($CFG->$key)) {
return $CFG->$key;
}
return null;
}
/**
* This function sets a config variable
* both in $CFG and in the database
*
* @param string $key config field to set
* @param string $value config value
*/
function set_config($key, $value) {
global $CFG;
db_ignore_sql_exceptions(true);
if (get_record('config', 'field', $key)) {
if (set_field('config', 'value', $value, 'field', $key)) {
$status = true;
}
}
else {
$config = new StdClass;
$config->field = $key;
$config->value = $value;
$status = insert_record('config', $config);
}
db_ignore_sql_exceptions(false);
if (!empty($status)) {
$CFG->{$key} = $value;
return true;
}
return false;
}
/**
* This function returns a value for $CFG for a plugin
* or null if it is not found
* note that it may go and look in the database
*
* @param string $plugintype eg artefact
* @param string $pluginname eg blog
* @param string $key the config setting to look for
*/
function get_config_plugin($plugintype, $pluginname, $key) {
global $CFG;
// Suppress NOTICE with @ in case $key is not yet cached
@$value = $CFG->plugin->{$plugintype}->{$pluginname}->{$key};
if (isset($value)) {
return $value;
}
$records = get_records_array($plugintype . '_config', 'plugin', $pluginname, 'field', 'field, value');
if (!empty($records)) {
foreach($records as $record) {
$CFG->plugin->{$plugintype}->{$pluginname}->{$record->field} = $record->value;
if ($record->field == $key) {
$value = $record->value;
}
}
}
return $value;
}
function set_config_plugin($plugintype, $pluginname, $key, $value) {
global $CFG;
$table = $plugintype . '_config';
if (false !== get_field($table, 'value', 'plugin', $pluginname, 'field', $key)) {
//if (set_field($table, 'value', $key, 'plugin', $pluginname, 'field', $value)) {
if (set_field($table, 'value', $value, 'plugin', $pluginname, 'field', $key)) {
$status = true;
}
}
else {
$pconfig = new StdClass;
$pconfig->plugin = $pluginname;
$pconfig->field = $key;
$pconfig->value = $value;
$status = insert_record($table, $pconfig);
}
if ($status) {
$CFG->plugin->{$plugintype}->{$pluginname}->{$key} = $value;
return true;
}
return false;
}
/**
* This function returns a value for $CFG for a plugin instance
* or null if it is not found. Initially this is interesting only
* for multiauth. Note that it may go and look in the database
*
* @param string $plugintype E.g. auth
* @param string $pluginname E.g. internal
* @param string $pluginid Instance id
* @param string $key The config setting to look for
*/
function get_config_plugin_instance($plugintype, $pluginid, $key) {
global $CFG;
// Must be unlikely to exist as a config option for any plugin
$instance = '_i_n_s_t'.$pluginid;
// Suppress NOTICE with @ in case $key is not yet cached
@$value = $CFG->plugin->{$plugintype}->{$instance}->{$key};
if (isset($value)) {
return $value;
}
$records = get_records_array($plugintype . '_instance_config', 'instance', $pluginid, 'field', 'field, value');
if (!empty($records)) {
foreach($records as $record) {
$CFG->plugin->{$plugintype}->{$instance}->{$record->field} = $record->value;
if ($record->field == $key) {
$value = $record->value;
}
}
}
return $value;
}
/**
* This function returns a value for $CFG for a plugin instance
* or null if it is not found. Initially this is interesting only
* for multiauth. Note that it may go and look in the database
*
* @param string $plugintype E.g. auth
* @param string $pluginname E.g. internal
* @param string $pluginid Instance id
* @param string $key The config setting to look for
*/
function set_config_plugin_instance($plugintype, $pluginname, $pluginid, $key, $value) {
global $CFG;
$table = $plugintype . '_instance_config';
if (false !== get_field($table, 'value', 'instance', $pluginid, 'field', $key)) {
if (set_field($table, 'value', $value, 'instance', $pluginid, 'field', $key)) {
$status = true;
}
}
else {
$pconfig = new StdClass;
$pconfig->instance = $pluginid;
$pconfig->field = $key;
$pconfig->value = $value;
$status = insert_record($table, $pconfig);
}
if ($status) {
// Must be unlikely to exist as a config option for any plugin
$instance = '_i_n_s_t'.$pluginid;
$CFG->plugin->{$plugintype}->{$pluginname}->{$instance}->{$key} = $value;
return true;
}
return false;
}
/**
* This function prints an array or object
* wrapped inside
*
* @param $mixed value to print
*/
function print_object($mixed) {
echo '';
print_r($mixed);
echo '';
}
/**
* This function returns the current
* language to use, either for a given user
* or sitewide, or the default
*
* @return string
*/
function current_language() {
global $USER, $CFG, $SESSION;
if ($USER instanceof User) {
$lang = $USER->get_account_preference('lang');
if ($lang !== null && $lang != 'default') {
if (language_installed($lang)) {
return $lang;
}
$USER->set_account_preference('lang', 'default');
}
}
if (is_a($SESSION, 'Session')) {
$sesslang = $SESSION->get('lang');
if (!empty($sesslang) && $sesslang != 'default') {
return $sesslang;
}
}
if (!empty($CFG->lang)) {
return $CFG->lang;
}
return 'en.utf8';
}
/**
* Helper function to sprintf language strings
* with a variable number of arguments
*
* @param string $string raw string to use
* @param array $args arguments to sprintf
*/
function format_langstring($string,$args) {
return call_user_func_array('sprintf',array_merge(array($string),$args));
}
/**
* Helper function to figure out whether an array is an array or a hash
* @param array $array array to check
* @return bool true if the array is a hash
*/
function is_hash($array) {
if (!is_array($array)) {
return false;
}
$diff = array_diff_assoc($array,array_values($array));
return !empty($diff);
}
/**
* Function to check if a directory exists and optionally create it.
*
* @param string absolute directory path
* @param boolean create directory if does not exist
* @param boolean create directory recursively
*
* @return boolean true if directory exists or created
*/
function check_dir_exists($dir, $create=true, $recursive=true) {
$status = true;
if(!is_dir($dir)) {
if (!$create) {
$status = false;
} else {
$mask = umask(0000);
$status = @mkdir($dir, get_config('directorypermissions'), true);
umask($mask);
}
}
return $status;
}
/**
* Function to require a plugin file. This is to avoid doing
* require and include directly with variables.
*
* This function is the one safe point to require plugin files.
* so USE it :)
*
* blocktypes are special cases. eg:
* system blocks: safe_require('blocktype', 'wall');
* artefact blocks: safe_require('blocktype', 'file/html');
*
* import/export plugins are special cases. eg:
* main library: safe_require('export', 'leap');
* artefact plugin implementation: safe_require('export', 'leap/file');
*
* @param string $plugintype the type of plugin (eg artefact)
* @param string $pluginname the name of the plugin (eg blog)
* @param string $filename the name of the file to include within the plugin structure
* @param string $function (optional, defaults to require) the require/include function to use
* @param string $nonfatal (optional, defaults to false) just returns false if the file doesn't exist
*/
function safe_require($plugintype, $pluginname, $filename='lib.php', $function='require_once', $nonfatal=false) {
$plugintypes = plugin_types();
if (!in_array($plugintype, $plugintypes)) {
throw new Exception("\"$plugintype\" is not a valid plugin type");
}
require_once(get_config('docroot') . $plugintype . '/lib.php');
if (!in_array($function,array('require', 'include', 'require_once', 'include_once'))) {
if (!empty($nonfatal)) {
return false;
}
throw new Exception ('invalid require type');
}
if ($plugintype == 'blocktype') { // these are a bit of a special case
$bits = explode('/', $pluginname);
if (count($bits) == 2) {
$fullpath = get_config('docroot') . 'artefact/' . $bits[0] . '/blocktype/' . $bits[1] . '/' . $filename;
}
else {
try {
if ($artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $pluginname)) {
$fullpath = get_config('docroot') . 'artefact/' . $artefactplugin . '/blocktype/' . $pluginname . '/'. $filename;
}
}
catch (SQLException $e) {
if (get_config('installed')) {
throw $e;
}
}
}
}
// these can have parts living inside artefact directories as well.
else if ($plugintype == 'export' || $plugintype == 'import') {
$bits = explode('/', $pluginname);
if (count($bits) == 2) {
$fullpath = get_config('docroot') . 'artefact/' . $bits[1] . '/' . $plugintype . '/' . $bits[0] . '/' . $filename;
}
}
if (empty($fullpath)) {
$fullpath = get_config('docroot') . $plugintype . '/' . $pluginname . '/' . $filename;
}
if (!$realpath = realpath($fullpath)) {
if (!empty($nonfatal)) {
return false;
}
throw new SystemException ("File $fullpath did not exist");
}
if (strpos($realpath, get_config('docroot') !== 0)) {
if (!empty($nonfatal)) {
return false;
}
throw new SystemException ("File $fullpath was outside document root!");
}
if ($function == 'require') { return require($realpath); }
if ($function == 'include') { return include($realpath); }
if ($function == 'require_once') { return require_once($realpath); }
if ($function == 'include_once') { return include_once($realpath); }
}
/**
* This function returns the list of plugintypes we currently care about.
*
* NOTE: use plugin_types_installed if you just want the installed ones.
*
* @return array of names
*/
function plugin_types() {
static $pluginstocheck;
if (empty($pluginstocheck)) {
// ORDER MATTERS! artefact has to be first!
$pluginstocheck = array('artefact', 'auth', 'notification', 'search', 'blocktype', 'interaction', 'grouptype', 'import', 'export');
}
return $pluginstocheck;
}
/**
* Returns plugin types that are actually installed
*/
function plugin_types_installed() {
static $plugins = array();
if (empty($plugins)) {
require_once('ddl.php');
foreach (plugin_types() as $plugin) {
if (table_exists(new XMLDBTable("{$plugin}_installed"))) {
$plugins[] = $plugin;
}
}
}
return $plugins;
}
/**
* This return returns the names of plugins installed
* for the given plugin type.
*
* @param string $plugintype type of plugin
*/
function plugins_installed($plugintype, $all=false) {
$sort = 'name';
if ($plugintype == 'blocktype') {
$sort = 'artefactplugin,name';
}
if ($all) {
return get_records_array($plugintype . '_installed', '', '', $sort);
}
return get_records_array($plugintype . '_installed', 'active', 1, $sort);
}
/**
* Helper to call a static method when you do not know the name of the class
* you want to call the method on. PHP5 does not support $class::method().
*/
function call_static_method($class, $method) {
$args = func_get_args();
array_shift($args);
array_shift($args);
return call_user_func_array(array($class, $method), $args);
}
function generate_class_name() {
$args = func_get_args();
if (count($args) == 2 && $args[0] == 'blocktype') {
return 'PluginBlocktype' . ucfirst(blocktype_namespaced_to_single($args[1]));
}
return 'Plugin' . implode('', array_map('ucfirst', $args));
}
function generate_artefact_class_name($type) {
return 'ArtefactType' . ucfirst($type);
}
function generate_interaction_instance_class_name($type) {
return 'Interaction' . ucfirst($type) . 'Instance';
}
function blocktype_namespaced_to_single($blocktype) {
if (strpos($blocktype, '/') === false) { // system blocktype
return $blocktype;
}
return substr($blocktype, strpos($blocktype, '/') + 1 );
}
function blocktype_single_to_namespaced($blocktype, $artefact='') {
if (empty($artefact)) {
return $blocktype;
}
return $artefact . '/' . $blocktype;
}
/**
* Given a blocktype name, convert it to the namespaced version.
*
* This will be $artefacttype/$blocktype, or just plain $blocktype for system
* blocktypes.
*
* This is useful for language strings
*/
function blocktype_name_to_namespaced($blocktype) {
static $resultcache = array();
if (!isset($resultcache[$blocktype])) {
$artefactplugin = get_field('blocktype_installed', 'artefactplugin', 'name', $blocktype);
if ($artefactplugin) {
$resultcache[$blocktype] = "$artefactplugin/$blocktype";
}
else {
$resultcache[$blocktype] = $blocktype;
}
}
return $resultcache[$blocktype];
}
/**
* Fires an event which can be handled by different parts of the system
*/
function handle_event($event, $data) {
if (!$e = get_record('event_type', 'name', $event)) {
throw new Exception("Invalid event");
}
if ($data instanceof ArtefactType || $data instanceof BlockInstance) {
// leave it alone
}
else if (is_object($data)) {
$data = (array)$data;
}
else if (is_numeric($data)) {
$data = array('id' => $data);
}
if ($coreevents = get_records_array('event_subscription', 'event', $event)) {
require_once('activity.php'); // core events can generate activity.
foreach ($coreevents as $ce) {
if (function_exists($ce->callfunction)) {
call_user_func($ce->callfunction, $data);
}
else {
log_warn("Event $event caused a problem with a core subscription "
. " $ce->callfunction, which wasn't callable. Continuing with event handlers");
}
}
}
$plugintypes = plugin_types_installed();
foreach ($plugintypes as $name) {
if ($subs = get_records_array($name . '_event_subscription', 'event', $event)) {
foreach ($subs as $sub) {
safe_require($name, $sub->plugin);
$classname = 'Plugin' . ucfirst($name) . ucfirst($sub->plugin);
try {
call_static_method($classname, $sub->callfunction, $event, $data);
}
catch (Exception $e) {
log_warn("Event $event caused an exception from plugin $classname "
. "with function $sub->callfunction. Continuing with event handlers");
}
}
}
}
}
/**
* function to convert an array of objects to
* an array containing one field per place
*
* @param array $array input array
* @param mixed $field field to look for in each object
*/
function mixed_array_to_field_array($array, $field) {
$repl_fun = create_function('$n, $field', '$n = (object)$n; return $n->{$field};');
$fields = array_pad(array(), count($array), $field);
return array_map($repl_fun, $array, $fields);
}
/**
* Adds stuff to the log
* @todo write this function
*
* @param string $plugintype plugin type or core
* @param string $pluginname plugin name or core component (eg 'view')
* @param string $action action string (like 'add')
* @param int $user id of user making the action
* @param int $id relevant id (ie, profile view would have id of profile owner)
*
*/
function add_to_log($plugintype, $pluginname, $action, $user, $id=0) {
}
/**
* Used by XMLDB
*/
function debugging ($message, $level) {
log_debug($message);
}
function xmldb_dbg($message) {
log_warn($message);
}
define('DEBUG_DEVELOPER', 'whocares');
/**
* Base class for all plugintypes.
*/
class Plugin {
/**
* This function returns an array of crons it wants to have run
* Each item should be a StdClass object containing -
* - callfunction (static function on the Plugin Class)
* - any or all of minute, hour, day, month, dayofweek
* (will default to * if not supplied)
*/
public static function get_cron() {
return array();
}
/**
* This function returns an array of events to subscribe to
* by unique name.
* If an event the plugin is trying to subscribe to is unknown by the
* core, an exception will be thrown.
* @return array
*/
public static function get_event_subscriptions() {
return array();
}
/**
* This function will be run after every upgrade to the plugin.
*
* @param int $fromversion version upgrading from (or 0 if installing)
*/
public static function postinst($fromversion) {
return true;
}
/**
* Whether this plugin has admin plugin config options.
* If you return true here, you must supply a valid pieform
* in {@link get_config}
*/
public static function has_config() {
return false;
}
/**
* Does this plugin offer any activity types
* If it does, you must subclass ActivityTypePlugin like
* ActivityType{$PluginType}{$Pluginname}
*/
public static function get_activity_types() {
return array();
}
/**
* Can this plugin be disabled?
* All internal type plugins, and ones in which Mahara won't work should override this.
* Probably at least one plugin per plugin-type should override this.
*/
public static function can_be_disabled() {
return true;
}
}
/**
* formats a unix timestamp to a nice date format.
*
* @param int $date unix timestamp to format
* @param string $formatkey language key to fetch the format from
* @param string $notspecifiedkey (optional) language key to fetch 'not specified string' from
* @param string $notspecifiedsection (optional) language section to fetch 'not specified string' from
* (see langconfig.php or the top of {@link get_string_location}
* for supported keys
*/
function format_date($date, $formatkey='strftimedatetime', $notspecifiedkey='strftimenotspecified', $notspecifiedsection='mahara') {
if (empty($date)) {
return get_string($notspecifiedkey, $notspecifiedsection);
}
return strftime(get_string($formatkey), $date);
}
/**
* Returns a random string suitable for registration/change password requests
*
* @param int $length The length of the key to return
* @return string
*/
function get_random_key($length=16) {
if ($length < 1) {
throw new IllegalArgumentException('Length must be a positive number');
}
$pool = array_merge(
range('A', 'Z'),
range('a', 'z'),
range(0, 9)
);
shuffle($pool);
$result = '';
for ($i = 0; $i < $length; $i++) {
$result .= $pool[$i];
}
return $result;
}
//
// Pieform related functions
//
/**
* Configures a default form
*/
function pieform_configure() {
global $USER, $THEME;
$renderer = $THEME->formrenderer;
return array(
'method' => 'post',
'action' => '',
'language' => current_language(),
'autofocus' => true,
'renderer' => $renderer,
'requiredmarker' => true,
'elementclasses' => true,
'descriptionintwocells' => true,
'jsdirectory' => get_config('wwwroot') . 'lib/pieforms/static/core/',
'replycallback' => 'pieform_reply',
'jserrorcallback' => 'formError',
'globaljserrorcallback' => 'formGlobalError',
'jssuccesscallback' => 'formSuccess',
'presubmitcallback' => 'formStartProcessing',
'postsubmitcallback' => 'formStopProcessing',
'jserrormessage' => get_string('errorprocessingform'),
'configdirs' => get_config('libroot') . 'form/',
'helpcallback' => 'pieform_get_help',
'elements' => array(
'sesskey' => array(
'type' => 'hidden',
'value' => $USER->get('sesskey')
)
)
);
}
function pieform_validate(Pieform $form, $values) {
global $USER;
if (!isset($values['sesskey'])) {
throw new UserException('No session key');
}
if ($USER && $USER->is_logged_in() && $USER->get('sesskey') != $values['sesskey']) {
throw new UserException('Invalid session key');
}
// Check to make sure the user has not been suspended or deleted, so that they cannot
// perform any action
if ($USER) {
$record = get_record_sql('SELECT suspendedctime, suspendedreason, deleted
FROM {usr}
WHERE id = ?', array($USER->get('id')));
if ($record) {
if ($record->suspendedctime) {
throw new UserException(get_string('accountsuspended', 'mahara', $record->suspendedctime, $record->suspendedreason));
}
if ($record->deleted) {
$USER->logout();
throw new AccessDeniedException(get_string('accountdeleted', 'mahara'));
}
}
}
}
function pieform_reply($code, $data) {
global $SESSION;
if (isset($data['message'])) {
if ($code == PIEFORM_ERR) {
$SESSION->add_error_msg($data['message']);
}
else {
$SESSION->add_ok_msg($data['message']);
}
}
if (isset($data['goto'])) {
redirect($data['goto']);
}
// NOT explicitly exiting here. Pieforms will throw an exception which will
// force the user to fix their form
}
function pieform_element_calendar_configure($element) {
global $THEME;
$element['jsroot'] = get_config('wwwroot') . 'js/jscalendar/';
$element['themefile'] = $THEME->get_url('style/calendar.css');
$element['imagefile'] = $THEME->get_url('images/calendar.gif');
$language = substr(current_language(), 0, 2);
$element['language'] = $language;
return $element;
}
function pieform_element_textarea_configure($element) {
if (!array_key_exists('resizable', $element)) {
$element['resizable'] = true;
}
return $element;
}
/**
* Should be used to provide the 'templatedir' directive to pieforms using a
* template for layout.
*
* @param string $file The file to be used as a pieform template, e.g.
* "admin/site/files.php". This is the value you used as
* the 'template' option for your pieform
* @param string $pluginlocation Which plugin to search for the template, e.g.
* artefact/file
*/
function pieform_template_dir($file, $pluginlocation='') {
global $THEME;
foreach ($THEME->inheritance as $themedir) {
$filepath = get_config('docroot') . $pluginlocation . '/theme/' . $themedir . '/pieforms/' . $file;
if (is_readable($filepath)) {
return dirname($filepath);
}
}
throw new SystemException('No pieform template available: ' . $file);
}
/**
* 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)
* @param string $usertoken Key created by view owner for logged-out user access
* @param string $mnettoken Key created by mahara for teachers roaming from moodle
*
* @returns boolean Wether the specified user can look at the specified view.
*/
function can_view_view($view_id, $user_id=null, $usertoken=null, $mnettoken=null) {
global $USER, $SESSION;
$now = time();
$dbnow = db_format_timestamp($now);
if ($user_id === null) {
$user_id = $USER->get('id');
}
$publicviews = get_config('allowpublicviews');
if ($publicviews) {
if (!$usertoken) {
$usertoken = get_cookie('viewaccess:'.$view_id);
}
if ($usertoken && (!$user_id || $user_id == $USER->get('id')) && $view_id == get_view_from_token($usertoken)) {
return true;
}
}
if (!$USER->is_logged_in()) {
// check public
$publicprofiles = get_config('allowpublicprofiles');
if ($publicviews || $publicprofiles) {
$public = get_records_sql_array("
SELECT
v.id, v.type, a.*
FROM
{view} v
LEFT OUTER JOIN {view_access} a ON v.id = a.view
WHERE
v.id = ? AND a.accesstype = 'public'
", array($view_id));
// If no public permissions
if ($public == false) {
return false;
}
foreach ($public as $k => $v) {
if ( ($v->startdate == null || $v->startdate < $dbnow) && ($v->stopdate == null || $v->stopdate > $dbnow) ) {
return ($publicviews || ($publicprofiles && $v->type == 'profile'));
}
}
}
return false;
}
// The user is logged in; they can see the view if
// - they can edit it, or
// - it has been submitted to them for assessment, or
// - they have been granted access via the edit view access page.
if ($SESSION->get('mnetuser')) {
if (!$mnettoken) {
$mnettoken = get_cookie('mviewaccess:'.$view_id);
}
if ($mnettoken && $view_id == get_view_from_token($mnettoken, false)) {
$mnetviewlist = $SESSION->get('mnetviewaccess');
if (empty($mnetviewlist)) {
$mnetviewlist = array();
}
$mnetviewlist[$view_id] = true;
$SESSION->set('mnetviewaccess', $mnetviewlist);
return true;
}
}
require_once(get_config('docroot') . 'lib/view.php');
$view = new View($view_id);
if ($USER->can_edit_view($view)) {
return true;
}
if ($submitgroup = $view->get('submittedgroup')) {
require_once(get_config('docroot') . 'lib/group.php');
if (group_user_can_assess_submitted_views($submitgroup, $user_id)) {
return true;
}
}
// Check access for loggedin, friends, user, group
$access = get_records_sql_array('
SELECT accesstype AS type,
CASE WHEN accesstype = \'friends\' THEN 4 ELSE 1 END AS typeorder,
' . db_format_tsfield('startdate') . ', ' . db_format_tsfield('stopdate') . '
FROM {view_access}
WHERE view = ?
UNION
SELECT \'user\' AS type, 2 AS typeorder, ' . db_format_tsfield('startdate') . ', ' . db_format_tsfield('stopdate') . '
FROM {view_access_usr}
WHERE view = ? AND usr = ?
UNION
SELECT \'group\' AS type, 3 AS typeorder, ' . db_format_tsfield('startdate') . ', ' . db_format_tsfield('stopdate') . '
FROM
{view_access_group} vg
INNER JOIN {group} g ON (vg.group = g.id AND g.deleted = 0)
INNER JOIN {group_member} m ON (g.id = m.group AND (vg.role IS NULL OR vg.role = m.role))
WHERE vg.view = ? AND m.member = ?
ORDER BY typeorder ', array($view_id, $view_id, $user_id, $view_id, $user_id));
if (empty($access)) {
return false;
}
foreach ($access as $a) {
if ($a->type == '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;
}
}
if (($a->startdate == null || $a->startdate < $now) && ($a->stopdate == null || $a->stopdate > $now)) {
return true;
}
}
return false;
}
/* return the view associated with a given token */
function get_view_from_token($token, $visible=true) {
if (!$token) {
return false;
}
return get_field_sql('
SELECT view
FROM {view_access_token}
WHERE token = ? AND visible = ?
AND (startdate IS NULL OR startdate < current_timestamp)
AND (stopdate IS NULL OR stopdate > current_timestamp)
', array($token, (int)$visible));
}
/**
* get the views that a user can see belonging
* to the given users
*
* @param array $users users to fetch views owned by
* @param int $userlooking (optional, defaults to logged in user)
* @param int $limit grab this many views. (setting this null means get all)
*
* @return array Associative array keyed by userid, of arrays of view ids
*/
function get_views($users, $userlooking=null, $limit=5, $type=null) {
$userlooking = optional_userid($userlooking);
if (is_int($users)) {
$users = array($users);
}
$list = array();
if(count($users) == 0) {
return $list;
}
$users = array_flip($users);
$dbnow = db_format_timestamp(time());
if ($friends = get_records_sql_array(
'SELECT
CASE WHEN usr1=? THEN usr2 ELSE usr1 END AS id
FROM
{usr_friend} f
WHERE
( usr1=? AND usr2 IN (' . join(',',array_map('db_quote', array_keys($users))) . ') )
OR
( usr2=? AND usr1 IN (' . join(',',array_map('db_quote', array_keys($users))) . ') )
',
array($userlooking,$userlooking,$userlooking)
)) {
foreach ( $friends as $user_id ) {
$users[$user_id->id] = 'friend';
}
}
if (is_null($type)) {
$typesql = "AND v.type != 'profile'";
}
else {
$typesql = 'AND v.type = ' . db_quote($type);
}
// public, logged in, or friends' views
if ($results = get_records_sql_array(
'SELECT
v.*,
' . db_format_tsfield('atime') . ',
' . db_format_tsfield('mtime') . ',
' . db_format_tsfield('ctime') . '
FROM
{view} v
INNER JOIN {view_access} a ON
v.id=a.view
AND (
accesstype IN (\'public\',\'loggedin\')
' . (
count(preg_grep('/^friend$/', $users)) > 0
? 'OR (
accesstype = \'friends\'
AND v.owner IN (' . join(',',array_map('db_quote', array_keys(preg_grep('/^friend$/', $users)))) . ')
)'
: ''
)
. '
)
WHERE
v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
AND ( v.startdate IS NULL OR v.startdate < ? )
AND ( v.stopdate IS NULL OR v.stopdate > ? )
' . $typesql,
array( $dbnow, $dbnow )
)
) {
foreach ($results as &$row) {
$list[$row->owner][$row->id] = $row;
}
}
// bail if we've filled all users to the limit
if (_get_views_trim_list($list, $users, $limit)) {
return $list;
}
// check individual user access
if ($results = get_records_sql_array(
'SELECT
v.*,
' . db_format_tsfield('atime') . ',
' . db_format_tsfield('mtime') . ',
' . db_format_tsfield('ctime') . '
FROM
{view} v
INNER JOIN {view_access_usr} a ON v.id=a.view AND a.usr=?
WHERE
v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
AND ( v.startdate IS NULL OR v.startdate < ? )
AND ( v.stopdate IS NULL OR v.stopdate > ? )
' . $typesql,
array($userlooking, $dbnow, $dbnow)
)
) {
foreach ($results as &$row) {
$list[$row->owner][$row->id] = $row;
}
}
// bail if we've filled all users to the limit
if (_get_views_trim_list($list, $users, $limit)) {
return $list;
}
// check group access
if ($results = get_records_sql_array(
'SELECT
v.*,
' . db_format_tsfield('v.atime','atime') . ',
' . db_format_tsfield('v.mtime','mtime') . ',
' . db_format_tsfield('v.ctime','ctime') . '
FROM
{view} v
INNER JOIN {view_access_group} a ON v.id=a.view
INNER JOIN {group_member} m ON m.group=a.group AND m.member=?
INNER JOIN {group} g ON (g.id = a.group AND g.deleted = ?)
WHERE
v.owner IN (' . join(',',array_map('db_quote', array_keys($users))) . ')
AND ( v.startdate IS NULL OR v.startdate < ? )
AND ( v.stopdate IS NULL OR v.stopdate > ? )
' . $typesql,
array($userlooking, 0, $dbnow, $dbnow)
)
) {
foreach ($results as &$row) {
$list[$row->owner][$row->id] = $row;
}
}
// bail if we've filled all users to the limit
if (_get_views_trim_list($list, $users, $limit)) {
return $list;
}
return $list;
}
function _get_views_trim_list(&$list, &$users, $limit) {
if ($limit === null) {
return;
}
foreach ($list as $user_id => &$views) {
if($limit and count($views) > $limit) {
$views = array_slice($views, 0, $limit);
}
if($limit and count($views) == $limit) {
unset($users[$user_id]);
}
}
if (count($users) == 0) {
return true;
}
return false;
}
function artefact_in_view($artefact, $view) {
$sql = 'SELECT a.id
FROM {view_artefact} a WHERE view = ? AND artefact = ?
UNION
SELECT c.parent
FROM {view_artefact} top JOIN {artefact_parent_cache} c
ON c.parent = top.artefact
WHERE top.view = ? AND c.artefact = ?';
return record_exists_sql($sql, array($view, $artefact, $view, $artefact));
}
function get_dir_contents($directory) {
$contents = array();
$dirhandle = opendir($directory);
while (false !== ($dir = readdir($dirhandle))) {
if (strpos($dir, '.') === 0) {
continue;
}
$contents[] = $dir;
}
return $contents;
}
/**
* Returns the subdirectory where mahara is installed, normally / but could
* be something different on a shared host. Useful for setting cookie paths.
*
* @return string
*/
function get_mahara_install_subdirectory() {
$wwwroot = get_config('wwwroot');
$wwwroot = preg_replace('#^https?://#', '', $wwwroot);
return substr($wwwroot, strpos($wwwroot, '/'));
}
/**
*** get_performance_info() pairs up with init_performance_info()
*** loaded in init.php. Returns an array with 'html' and 'txt'
*** values ready for use, and each of the individual stats provided
*** separately as well.
***
**/
function get_performance_info() {
if (!get_config('perftofoot') && !get_config('perftolog')) {
return array();
}
global $PERF;
$info = array();
$info['realtime'] = microtime_diff($PERF->starttime, microtime());
if (function_exists('memory_get_usage')) {
$info['memory_total'] = memory_get_usage();
$info['memory_growth'] = memory_get_usage() - $PERF->startmemory;
}
$inc = get_included_files();
$info['includecount'] = count($inc);
$info['dbreads'] = $PERF->dbreads;
$info['dbwrites'] = $PERF->dbwrites;
if (function_exists('posix_times')) {
$ptimes = posix_times();
if (is_array($ptimes)) {
foreach ($ptimes as $key => $val) {
$info[$key] = $ptimes[$key] - $PERF->startposixtimes[$key];
}
}
}
// Grab the load average for the last minute
// /proc will only work under some linux configurations
// while uptime is there under MacOSX/Darwin and other unices
if (is_readable('/proc/loadavg') && $loadavg = @file('/proc/loadavg')) {
list($server_load) = explode(' ', $loadavg[0]);
unset($loadavg);
} else if ( function_exists('is_executable') && is_executable('/usr/bin/uptime') && $loadavg = `/usr/bin/uptime` ) {
if (preg_match('/load averages?: (\d+[\.,:]\d+)/', $loadavg, $matches)) {
$server_load = $matches[1];
} else {
log_debug('PERF: Could not parse uptime output!');
}
}
if (!empty($server_load)) {
$info['serverload'] = $server_load;
}
else {
$info['serverload'] = 'unknown';
}
return $info;
}
function perf_to_log($info=null) {
if (!get_config('perftolog')) {
return true;
}
if (empty($info)) {
$info = get_performance_info();
}
$logstring = 'PERF: ' . strip_querystring(get_script_path()). ': ';
$logstring .= ' memory_total: '.$info['memory_total'].'B (' . display_size($info['memory_total']).') memory_growth: '.$info['memory_growth'].'B ('.display_size($info['memory_growth']).')';
$logstring .= ' time: '.$info['realtime'].'s';
$logstring .= ' includecount: '.$info['includecount'];
$logstring .= ' dbqueries: '.$info['dbreads'] . ' reads, ' . $info['dbwrites'] . ' writes';
$logstring .= ' ticks: ' . $info['ticks'] . ' user: ' . $info['utime'] . ' sys: ' . $info['stime'] .' cuser: ' . $info['cutime'] . ' csys: ' . $info['cstime'];
$logstring .= ' serverload: ' . $info['serverload'];
log_debug($logstring);
}
/**
* microtime_diff
*
* @param string $a ?
* @param string $b ?
* @return string
* @todo Finish documenting this function
*/
function microtime_diff($a, $b) {
list($a_dec, $a_sec) = explode(' ', $a);
list($b_dec, $b_sec) = explode(' ', $b);
return $b_sec - $a_sec + $b_dec - $a_dec;
}
/**
* Function to raise the memory limit to a new value.
* Will respect the memory limit if it is higher, thus allowing
* settings in php.ini, apache conf or command line switches
* to override it
*
* The memory limit should be expressed with a string (eg:'64M')
*
* @param string $newlimit the new memory limit
* @return bool Whether we were able to raise the limit or not
*/
function raise_memory_limit ($newlimit) {
if (empty($newlimit)) {
return false;
}
$cur = @ini_get('memory_limit');
if (empty($cur)) {
// If php is compiled without --enable-memory-limits
// apparently memory_limit is set to ''
$cur=0;
}
else {
if ($cur == -1){
return true; // unlimited mem!
}
$cur = get_real_size($cur);
}
$new = get_real_size($newlimit);
if ($new > $cur) {
ini_set('memory_limit', $newlimit);
return true;
}
return false;
}
/**
* Converts numbers like 10M into bytes.
*
* @param string $size The size to be converted
* @return integer
* @throws SystemException if the string does not have a valid suffix.
* See the function definition for allowed suffixes.
*/
function get_real_size($size=0) {
if (!$size) {
return 0;
}
// If there is no suffix then assume bytes
else if (is_numeric($size)) return (int)$size;
$scan = array(
'MB' => 1048576,
'Mb' => 1048576,
'M' => 1048576,
'm' => 1048576,
'KB' => 1024,
'Kb' => 1024,
'K' => 1024,
'k' => 1024,
);
while (list($key) = each($scan)) {
if (strlen($size) > strlen($key) && substr($size, -strlen($key)) == $key) {
$size = substr($size, 0, -strlen($key)) * $scan[$key];
return $size;
}
}
throw new SystemException('get_real_size called without valid size');
}
/**
* Converts bytes into display form
*
* @param string $size ?
* @return string
* @staticvar string $gb Localized string for size in gigabytes
* @staticvar string $mb Localized string for size in megabytes
* @staticvar string $kb Localized string for size in kilobytes
* @staticvar string $b Localized string for size in bytes
* @todo Finish documenting this function. Verify return type.
*/
function display_size($size) {
static $gb, $mb, $kb, $b;
if (empty($gb)) {
$gb = get_string('sizegb');
$mb = get_string('sizemb');
$kb = get_string('sizekb');
$b = get_string('sizeb');
}
if ($size >= 1073741824) {
$size = round($size / 1073741824 * 10) / 10 . $gb;
} else if ($size >= 1048576) {
$size = round($size / 1048576 * 10) / 10 . $mb;
} else if ($size >= 1024) {
$size = round($size / 1024 * 10) / 10 . $kb;
} else {
$size = $size .' '. $b;
}
return $size;
}
/**
* creates the profile sideblock
*/
function profile_sideblock() {
global $USER, $SESSION;
safe_require('notification', 'internal');
require_once('group.php');
$data = array(
'id' => $USER->get('id'),
'myname' => display_name($USER, null, true),
'username' => $USER->get('username'),
'profileicon' => $USER->get('profileicon') ? $USER->get('profileicon') : 0,
);
$authinstance = $SESSION->get('mnetuser') ? $SESSION->get('authinstance') : $USER->get('authinstance');
if ($authinstance) {
$authobj = AuthFactory::create($authinstance);
if ($authobj->authname == 'xmlrpc') {
$peer = get_peer($authobj->wwwroot);
if ($SESSION->get('mnetuser')) {
$data['mnetloggedinfrom'] = get_string('youhaveloggedinfrom', 'auth.xmlrpc', $authobj->wwwroot, $peer->name);
}
else {
$data['peer'] = array('name' => $peer->name, 'wwwroot' => $peer->wwwroot);
}
}
}
$data['unreadnotifications'] = call_static_method(generate_class_name('notification', 'internal'), 'unread_count', $USER->get('id'));
$data['unreadnotificationsmessage'] = $data['unreadnotifications'] == 1 ? get_string('unreadmessage') : get_string('unreadmessages');
$invitedgroups = get_records_sql_array('SELECT g.*, gmi.ctime, gmi.reason
FROM {group} g
JOIN {group_member_invite} gmi ON gmi.group = g.id
WHERE gmi.member = ? AND g.deleted = ?', array($USER->get('id'), 0));
$data['invitedgroups'] = $invitedgroups ? count($invitedgroups) : 0;
$data['invitedgroupsmessage'] = $data['invitedgroups'] == 1 ? get_string('invitedgroup') : get_string('invitedgroups');
$data['pendingfriends'] = count_records('usr_friend_request', 'owner', $USER->get('id'));
$data['pendingfriendsmessage'] = $data['pendingfriends'] == 1 ? get_string('pendingfriend') : get_string('pendingfriends');
$data['groups'] = group_get_user_groups($USER->get('id'));
$data['views'] = get_records_sql_array(
'SELECT v.id, v.title
FROM {view} v
INNER JOIN {view_tag} vt ON (vt.tag = ? AND vt.view = v.id)
WHERE v.owner = ?
ORDER BY v.title',
array(get_string('profile'), $USER->get('id'))
);
$data['artefacts'] = get_records_sql_array(
'SELECT a.id, a.artefacttype, a.title
FROM {artefact} a
INNER JOIN {artefact_tag} at ON (a.id = at.artefact AND tag = ?)
WHERE a.owner = ?
ORDER BY a.title',
array(get_string('profile'), $USER->get('id'))
);
return $data;
}
/**
* Gets data about users who have been online in the last while.
*
* The time is configured by setting the 'accessidletimeout' configuration
* option.
*
* NOTE: currently returns all online users, this might not be desirable on a
* really busy site.
*/
function onlineusers_sideblock() {
global $USER;
$onlineusers = get_records_select_array('usr', 'deleted = 0 AND lastaccess > ?',
array(db_format_timestamp(time() - get_config('accessidletimeout'))), 'lastaccess DESC');
if ($onlineusers) {
foreach ($onlineusers as &$user) {
// Use 'profileiconbyid' for the current user, just in case they change their profile icon
if ($user->id == $USER->get('id')) {
$user->profileiconurl = get_config('wwwroot') . 'thumb.php?type=profileiconbyid&id=' . (int)$user->profileicon . '&size=20x20';
}
else {
$user->profileiconurl = get_config('wwwroot') . 'thumb.php?type=profileicon&id=' . $user->id . '&size=20x20';
}
// If the user is an MNET user, show where they've come from
$authobj = AuthFactory::create($user->authinstance);
if ($authobj->authname == 'xmlrpc') {
$peer = get_peer($authobj->wwwroot);
$user->loggedinfrom = $peer->name;
}
}
}
else {
$onlineusers = array();
}
return array(
'users' => $onlineusers,
'count' => count($onlineusers),
'lastminutes' => floor(get_config('accessidletimeout') / 60),
);
}
function tag_weight($freq) {
return pow($freq, 2);
// return log10($freq);
}
function get_my_tags($limit=null, $cloud=true, $sort='freq') {
global $USER;
$id = $USER->get('id');
if ($limit || $sort != 'alpha') {
$sort = 'COUNT(t.tag) DESC';
}
else {
$sort = 't.tag ASC';
}
$tagrecords = get_records_sql_array("
SELECT
t.tag, COUNT(t.tag) AS count
FROM (
(SELECT at.tag, a.id, 'artefact' AS type
FROM {artefact_tag} at JOIN {artefact} a ON a.id = at.artefact
WHERE a.owner = ?)
UNION
(SELECT vt.tag, v.id, 'view' AS type
FROM {view_tag} vt JOIN {view} v ON v.id = vt.view
WHERE v.owner = ?)
) t
GROUP BY t.tag
ORDER BY " . $sort . (is_null($limit) ? '' : " LIMIT $limit"),
array($id, $id)
);
if (!$tagrecords) {
return false;
}
if ($cloud) {
$minfreq = $tagrecords[count($tagrecords) - 1]->count;
$maxfreq = $tagrecords[0]->count;
if ($minfreq != $maxfreq) {
$minweight = tag_weight($minfreq);
$maxweight = tag_weight($maxfreq);
$minsize = 0.8;
$maxsize = 2.5;
foreach ($tagrecords as &$t) {
$weight = (tag_weight($t->count) - $minweight) / ($maxweight - $minweight);
$t->size = sprintf("%0.1f", $minsize + ($maxsize - $minsize) * $weight);
}
}
usort($tagrecords, create_function('$a,$b', 'return strnatcasecmp($a->tag, $b->tag);'));
}
else {
foreach ($tagrecords as &$t) {
$t->tagurl = urlencode($t->tag);
}
}
return $tagrecords;
}
function tags_sideblock() {
global $USER;
$maxtags = $USER->get_account_preference('tagssideblockmaxtags');
$maxtags = is_null($maxtags) ? get_config('tagssideblockmaxtags') : $maxtags;
if ($tagrecords = get_my_tags($maxtags)) {
return array('tags' => $tagrecords);
}
return null;
}
/**
* Cronjob to recalculate how much quota each user is using and update it as
* appropriate.
*
* This gives a backstop for the possibility that there is a bug elsewhere that
* has caused the quota count to get out of sync
*/
function recalculate_quota() {
$plugins = plugins_installed('artefact', true);
$userquotas = array();
foreach ($plugins as $plugin) {
safe_require('artefact', $plugin->name);
$classname = generate_class_name('artefact', $plugin->name);
if (is_callable($classname . '::recalculate_quota')) {
$pluginuserquotas = call_static_method($classname, 'recalculate_quota');
foreach ($pluginuserquotas as $userid => $usage) {
if (!isset($userquotas[$userid])) {
$userquotas[$userid] = $usage;
}
else {
$userquotas[$userid] += $usage;
}
}
}
}
foreach ($userquotas as $user => $quota) {
$data = (object) array(
'quotaused' => $quota
);
$where = (object) array(
'id' => $user
);
update_record('usr', $data, $where);
}
}
/**
* Cronjob to send an update of site statistics to mahara.org
*/
function cron_send_registration_data() {
if (!get_config('registration_sendweeklyupdates')) {
return;
}
require_once(get_config('libroot') . 'registration.php');
$result = registration_send_data();
if ($result->data != '1') {
log_info($result);
}
else {
set_config('registration_lastsent', time());
}
}
/**
* Cronjob to save weekly site data locally
*/
function cron_site_data_weekly() {
require_once(get_config('libroot') . 'registration.php');
$current = site_data_current();
$time = db_format_timestamp(time());
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'user-count',
'value' => $current['users'],
));
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'group-count',
'value' => $current['groups'],
));
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'view-count',
'value' => $current['views'],
));
}
function cron_site_data_daily() {
require_once(get_config('libroot') . 'registration.php');
$current = site_data_current();
$time = db_format_timestamp(time());
require_once('function.dirsize.php');
if ($diskusage = dirsize(get_config('dataroot'))) {
// Currently there is no need to track disk usage
// over time, so delete old records first.
delete_records('site_data', 'type', 'disk-usage');
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'disk-usage',
'value' => $diskusage,
));
}
// Total users
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'user-count-daily',
'value' => $current['users'],
));
// Logged-in users
$interval = is_postgres() ? "'1 day'" : '1 day';
$where = "lastaccess >= CURRENT_DATE AND lastaccess < CURRENT_DATE + INTERVAL $interval";
insert_record('site_data', (object) array(
'ctime' => $time,
'type' => 'loggedin-users-daily',
'value' => count_records_select('usr', $where),
));
// Process log file containing view visits
if ($fh = @fopen(get_config('dataroot') . 'views.log', 'r')) {
// Read the new stuff out of the file
$latest = get_field('view_visit', 'MAX(ctime)');
if (empty($latest)) {
$latest = get_config('viewloglatest');
}
else {
set_config('viewloglatest', $latest);
}
$visits = array();
while (!feof($fh)) {
$line = fgets($fh, 1024);
if (preg_match('/^\[(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\] (\d+)$/', $line, $m) && $m[1] > $latest) {
$visits[] = (object) array('ctime' => $m[1], 'view' => $m[2]);
}
}
fclose($fh);
// Get per-view counts for the view table.
$visitcounts = array();
foreach ($visits as &$v) {
if (!isset($visitcounts[$v->view])) {
$visitcounts[$v->view] = 0;
}
$visitcounts[$v->view]++;
}
// Add visit records to view_visit
foreach ($visits as &$v) {
if (record_exists('view', 'id', $v->view)) {
insert_record('view_visit', $v);
}
}
// Delete view_visit records > 1 week old
delete_records_select(
'view_visit',
'ctime < CURRENT_DATE - INTERVAL ' . (is_postgres() ? "'1 week'" : '1 WEEK')
);
// Update view counts
foreach ($visitcounts as $viewid => $newvisits) {
execute_sql("UPDATE {view} SET visits = visits + ? WHERE id = ?", array($newvisits, $viewid));
}
}
}
function random_string($length=15) {
$pool = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
$poollen = strlen($pool);
mt_srand ((double) microtime() * 1000000);
$string = '';
for ($i = 0; $i < $length; $i++) {
$string .= substr($pool, (mt_rand()%($poollen)), 1);
}
return $string;
}
function build_portfolio_search_html(&$data) {
global $THEME;
$artefacttypes = get_records_assoc('artefact_installed_type');
foreach ($data->data as &$item) {
$item->ctime = format_date($item->ctime);
if ($item->type == 'view') {
$item->typestr = get_string('view');
$item->icon = $THEME->get_url('images/view.gif');
$item->url = get_config('wwwroot') . 'view/view.php?id=' . $item->id;
}
else { // artefact
safe_require('artefact', $artefacttypes[$item->artefacttype]->plugin);
$links = call_static_method(generate_artefact_class_name($item->artefacttype), 'get_links', $item->id);
$item->url = $links['_default'];
$item->icon = call_static_method(generate_artefact_class_name($item->artefacttype), 'get_icon', array('id' => $item->id));
$item->typestr = get_string($item->artefacttype, 'artefact.' . $artefacttypes[$item->artefacttype]->plugin);
}
}
$data->baseurl = get_config('wwwroot') . 'tags.php' . (is_null($data->tag) ? '' : '?tag=' . urlencode($data->tag));
$data->sortcols = array('name', 'date');
$data->filtercols = array(
'all' => get_string('tagfilter_all'),
'file' => get_string('tagfilter_file'),
'image' => get_string('tagfilter_image'),
'text' => get_string('tagfilter_text'),
'view' => get_string('tagfilter_view'),
);
$smarty = smarty_core();
$smarty->assign_by_ref('data', $data->data);
$data->tablerows = $smarty->fetch('portfoliosearchresults.tpl');
$pagination = build_pagination(array(
'id' => 'results_pagination',
'class' => 'center',
'url' => $data->baseurl . ($data->sort == 'name' ? '' : '&sort=' . $data->sort) . ($data->filter == 'all' ? '' : '&type=' . $data->filter),
'jsonscript' => 'json/tagsearch.php',
'datatable' => 'results',
'count' => $data->count,
'limit' => $data->limit,
'offset' => $data->offset,
'numbersincludefirstlast' => false,
'resultcounttextsingular' => get_string('result'),
'resultcounttextplural' => get_string('results'),
));
$data->pagination = $pagination['html'];
$data->pagination_js = $pagination['javascript'];
}
// When feedback becomes an artefact type, move this into the feedback artefact plugin
function build_feedback_html(&$data) {
foreach ($data->data as &$item) {
$item->date = format_date(strtotime($item->ctime), 'strftimedatetime');
$item->message = clean_html($item->message);
$item->name = $item->author ? display_name($item->author) : $item->authorname;
if (!empty($item->attachment)) {
$item->attachid = $item->attachment;
$item->attachtitle = $item->title;
$item->attachsize = display_size($item->size);
if ($data->isowner) {
$item->attachmessage = get_string('feedbackattachmessage', 'view', get_string('feedbackattachdirname', 'view'));
}
}
}
$extradata = array('view' => $data->view);
if (!empty($data->artefact)) {
$data->baseurl = get_config('wwwroot') . 'view/artefact.php?view=' . $data->view . '&artefact=' . $data->artefact;
$data->jsonscript = 'view/artefactfeedback.json.php';
$extradata['artefact'] = $data->artefact;
}
else {
$data->baseurl = get_config('wwwroot') . 'view/view.php?id=' . $data->view;
$data->jsonscript = 'view/viewfeedback.json.php';
}
$smarty = smarty_core();
$smarty->assign_by_ref('data', $data->data);
$smarty->assign('canedit', $data->canedit);
$smarty->assign('baseurl', $data->baseurl);
$data->tablerows = $smarty->fetch('view/feedbacklist.tpl');
$pagination = build_pagination(array(
'id' => 'feedback_pagination',
'class' => 'center',
'url' => $data->baseurl,
'jsonscript' => $data->jsonscript,
'datatable' => 'feedbacktable',
'count' => $data->count,
'limit' => $data->limit,
'offset' => $data->offset,
'lastpage' => $data->lastpage,
'resultcounttextsingular' => get_string('comment', 'view'),
'resultcounttextplural' => get_string('comments', 'view'),
'extradata' => $extradata,
));
$data->pagination = $pagination['html'];
$data->pagination_js = $pagination['javascript'];
}
?>