MDL-30979 output: Fixed up phpdocs for page requirements code
[moodle.git] / index.php
blob99bae5f6d3ccdf4d17f396f07fb4753c2998ccb2
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19 * Moodle frontpage.
21 * @package core
22 * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 if (!file_exists('./config.php')) {
27 header('Location: install.php');
28 die;
31 require_once('config.php');
32 require_once($CFG->dirroot .'/course/lib.php');
33 require_once($CFG->libdir .'/filelib.php');
35 redirect_if_major_upgrade_required();
37 if ($CFG->forcelogin) {
38 require_login();
39 } else {
40 user_accesstime_log();
43 $hassiteconfig = has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM));
45 $urlparams = array();
46 if ($CFG->defaulthomepage == HOMEPAGE_MY && optional_param('redirect', 1, PARAM_BOOL) === 0) {
47 $urlparams['redirect'] = 0;
49 $PAGE->set_url('/', $urlparams);
50 $PAGE->set_course($SITE);
52 /// If the site is currently under maintenance, then print a message
53 if (!empty($CFG->maintenance_enabled) and !$hassiteconfig) {
54 print_maintenance_message();
57 if ($hassiteconfig && moodle_needs_upgrading()) {
58 redirect($CFG->wwwroot .'/'. $CFG->admin .'/index.php');
61 if (get_home_page() != HOMEPAGE_SITE) {
62 // Redirect logged-in users to My Moodle overview if required
63 if (optional_param('setdefaulthome', false, PARAM_BOOL)) {
64 set_user_preference('user_home_page_preference', HOMEPAGE_SITE);
65 } else if ($CFG->defaulthomepage == HOMEPAGE_MY && optional_param('redirect', 1, PARAM_BOOL) === 1) {
66 redirect($CFG->wwwroot .'/my/');
67 } else if (!empty($CFG->defaulthomepage) && $CFG->defaulthomepage == HOMEPAGE_USER) {
68 $PAGE->settingsnav->get('usercurrentsettings')->add(get_string('makethismyhome'), new moodle_url('/', array('setdefaulthome'=>true)), navigation_node::TYPE_SETTING);
72 if (isloggedin()) {
73 add_to_log(SITEID, 'course', 'view', 'view.php?id='.SITEID, SITEID);
76 /// If the hub plugin is installed then we let it take over the homepage here
77 if (get_config('local_hub', 'hubenabled') && file_exists($CFG->dirroot.'/local/hub/lib.php')) {
78 require_once($CFG->dirroot.'/local/hub/lib.php');
79 $hub = new local_hub();
80 $continue = $hub->display_homepage();
81 //display_homepage() return true if the hub home page is not displayed
82 //mostly when search form is not displayed for not logged users
83 if (empty($continue)) {
84 exit;
88 $PAGE->set_pagetype('site-index');
89 $PAGE->set_other_editing_capability('moodle/course:manageactivities');
90 $PAGE->set_docs_path('');
91 $PAGE->set_pagelayout('frontpage');
92 $editing = $PAGE->user_is_editing();
93 $PAGE->set_title($SITE->fullname);
94 $PAGE->set_heading($SITE->fullname);
95 echo $OUTPUT->header();
97 /// Print Section or custom info
98 if (!empty($CFG->customfrontpageinclude)) {
99 include($CFG->customfrontpageinclude);
101 } else if ($SITE->numsections > 0) {
103 if (!$section = $DB->get_record('course_sections', array('course'=>$SITE->id, 'section'=>1))) {
104 $DB->delete_records('course_sections', array('course'=>$SITE->id, 'section'=>1)); // Just in case
105 $section->course = $SITE->id;
106 $section->section = 1;
107 $section->summary = '';
108 $section->summaryformat = FORMAT_HTML;
109 $section->sequence = '';
110 $section->visible = 1;
111 $section->id = $DB->insert_record('course_sections', $section);
114 if (!empty($section->sequence) or !empty($section->summary) or $editing) {
115 echo $OUTPUT->box_start('generalbox sitetopic');
117 /// If currently moving a file then show the current clipboard
118 if (ismoving($SITE->id)) {
119 $stractivityclipboard = strip_tags(get_string('activityclipboard', '', $USER->activitycopyname));
120 echo '<p><font size="2">';
121 echo "$stractivityclipboard&nbsp;&nbsp;(<a href=\"course/mod.php?cancelcopy=true&amp;sesskey=".sesskey()."\">". get_string('cancel') .'</a>)';
122 echo '</font></p>';
125 $context = get_context_instance(CONTEXT_COURSE, SITEID);
126 $summarytext = file_rewrite_pluginfile_urls($section->summary, 'pluginfile.php', $context->id, 'course', 'section', $section->id);
127 $summaryformatoptions = new stdClass();
128 $summaryformatoptions->noclean = true;
129 $summaryformatoptions->overflowdiv = true;
131 echo format_text($summarytext, $section->summaryformat, $summaryformatoptions);
133 if ($editing) {
134 $streditsummary = get_string('editsummary');
135 echo "<a title=\"$streditsummary\" ".
136 " href=\"course/editsection.php?id=$section->id\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" ".
137 " class=\"iconsmall\" alt=\"$streditsummary\" /></a><br /><br />";
140 get_all_mods($SITE->id, $mods, $modnames, $modnamesplural, $modnamesused);
141 print_section($SITE, $section, $mods, $modnamesused, true);
143 if ($editing) {
144 print_section_add_menus($SITE, $section->section, $modnames);
146 echo $OUTPUT->box_end();
150 if (isloggedin() and !isguestuser() and isset($CFG->frontpageloggedin)) {
151 $frontpagelayout = $CFG->frontpageloggedin;
152 } else {
153 $frontpagelayout = $CFG->frontpage;
156 foreach (explode(',',$frontpagelayout) as $v) {
157 switch ($v) { /// Display the main part of the front page.
158 case FRONTPAGENEWS:
159 if ($SITE->newsitems) { // Print forums only when needed
160 require_once($CFG->dirroot .'/mod/forum/lib.php');
162 if (! $newsforum = forum_get_course_forum($SITE->id, 'news')) {
163 print_error('cannotfindorcreateforum', 'forum');
166 // fetch news forum context for proper filtering to happen
167 $newsforumcm = get_coursemodule_from_instance('forum', $newsforum->id, $SITE->id, false, MUST_EXIST);
168 $newsforumcontext = get_context_instance(CONTEXT_MODULE, $newsforumcm->id, MUST_EXIST);
170 $forumname = format_string($newsforum->name, true, array('context' => $newsforumcontext));
171 echo html_writer::tag('a', get_string('skipa', 'access', moodle_strtolower(strip_tags($forumname))), array('href'=>'#skipsitenews', 'class'=>'skip-block'));
173 if (isloggedin()) {
174 $SESSION->fromdiscussion = $CFG->wwwroot;
175 $subtext = '';
176 if (forum_is_subscribed($USER->id, $newsforum)) {
177 if (!forum_is_forcesubscribed($newsforum)) {
178 $subtext = get_string('unsubscribe', 'forum');
180 } else {
181 $subtext = get_string('subscribe', 'forum');
183 echo $OUTPUT->heading($forumname, 2, 'headingblock header');
184 $suburl = new moodle_url('/mod/forum/subscribe.php', array('id' => $newsforum->id, 'sesskey' => sesskey()));
185 echo html_writer::tag('div', html_writer::link($suburl, $subtext), array('class' => 'subscribelink'));
186 } else {
187 echo $OUTPUT->heading($forumname, 2, 'headingblock header');
190 forum_print_latest_discussions($SITE, $newsforum, $SITE->newsitems, 'plain', 'p.modified DESC');
191 echo html_writer::tag('span', '', array('class'=>'skip-block-to', 'id'=>'skipsitenews'));
193 break;
195 case FRONTPAGECOURSELIST:
196 if (isloggedin() and !$hassiteconfig and !isguestuser() and empty($CFG->disablemycourses)) {
197 echo html_writer::tag('a', get_string('skipa', 'access', moodle_strtolower(get_string('mycourses'))), array('href'=>'#skipmycourses', 'class'=>'skip-block'));
198 echo $OUTPUT->heading(get_string('mycourses'), 2, 'headingblock header');
199 print_my_moodle();
200 echo html_writer::tag('span', '', array('class'=>'skip-block-to', 'id'=>'skipmycourses'));
201 } else if ((!$hassiteconfig and !isguestuser()) or ($DB->count_records('course') <= FRONTPAGECOURSELIMIT)) {
202 // admin should not see list of courses when there are too many of them
203 echo html_writer::tag('a', get_string('skipa', 'access', moodle_strtolower(get_string('availablecourses'))), array('href'=>'#skipavailablecourses', 'class'=>'skip-block'));
204 echo $OUTPUT->heading(get_string('availablecourses'), 2, 'headingblock header');
205 print_courses(0);
206 echo html_writer::tag('span', '', array('class'=>'skip-block-to', 'id'=>'skipavailablecourses'));
208 break;
210 case FRONTPAGECATEGORYNAMES:
211 echo html_writer::tag('a', get_string('skipa', 'access', moodle_strtolower(get_string('categories'))), array('href'=>'#skipcategories', 'class'=>'skip-block'));
212 echo $OUTPUT->heading(get_string('categories'), 2, 'headingblock header');
213 echo $OUTPUT->box_start('generalbox categorybox');
214 print_whole_category_list(NULL, NULL, NULL, -1, false);
215 echo $OUTPUT->box_end();
216 print_course_search('', false, 'short');
217 echo html_writer::tag('span', '', array('class'=>'skip-block-to', 'id'=>'skipcategories'));
218 break;
220 case FRONTPAGECATEGORYCOMBO:
221 echo html_writer::tag('a', get_string('skipa', 'access', moodle_strtolower(get_string('courses'))), array('href'=>'#skipcourses', 'class'=>'skip-block'));
222 echo $OUTPUT->heading(get_string('courses'), 2, 'headingblock header');
223 $renderer = $PAGE->get_renderer('core','course');
224 // if there are too many courses, budiling course category tree could be slow,
225 // users should go to course index page to see the whole list.
226 $coursecount = $DB->count_records('course');
227 if (empty($CFG->numcoursesincombo)) {
228 // if $CFG->numcoursesincombo hasn't been set, use default value 500
229 $CFG->numcoursesincombo = 500;
231 if ($coursecount > $CFG->numcoursesincombo) {
232 $link = new moodle_url('/course/');
233 echo $OUTPUT->notification(get_string('maxnumcoursesincombo', 'moodle', array('link'=>$link->out(), 'maxnumofcourses'=>$CFG->numcoursesincombo, 'numberofcourses'=>$coursecount)));
234 } else {
235 echo $renderer->course_category_tree(get_course_category_tree());
237 print_course_search('', false, 'short');
238 echo html_writer::tag('span', '', array('class'=>'skip-block-to', 'id'=>'skipcourses'));
239 break;
241 case FRONTPAGETOPICONLY: // Do nothing!! :-)
242 break;
245 echo '<br />';
248 echo $OUTPUT->footer();