This repository has been archived on 2024-09-05. You can view files and clone it, but cannot push or open issues or pull requests.
shimmie2/index.php

76 lines
2.6 KiB
PHP
Raw Normal View History

<?php
2009-07-21 03:18:40 +00:00
/**
* \mainpage Shimmie2 / SCore Documentation
*
* SCore is a framework designed for writing flexible, extendable applications.
2013-11-28 05:34:31 +00:00
* Whereas most PHP apps are built monolithically, score's event-based nature
* allows parts to be mixed and matched. For instance, the most famous
* collection of score extensions is the Shimmie image board, which includes
* user management, a wiki, a private messaging system, etc. But one could
* easily remove the image board bits and simply have a wiki with users and
* PMs; or one could replace it with a blog module; or one could have a blog
* which links to images on an image board, with no wiki or messaging, and so
* on and so on...
2014-02-22 20:36:52 +00:00
*
* Dijkstra will kill me for personifying my architecture, but I can't think
* of a better way without going into all the little details.
2013-11-28 05:34:31 +00:00
* There are a bunch of Extension subclasses, they talk to each other by sending
* and receiving Event subclasses. The primary driver for each conversation is the
2012-03-05 13:56:36 +00:00
* initial PageRequestEvent. If an Extension wants to display something to the
* user, it adds a block to the Page data store. Once the conversation is over, the Page is passed to the
2009-07-21 03:18:40 +00:00
* current theme's Layout class which will tidy up the data and present it to
2012-03-05 13:56:36 +00:00
* the user. To see this in a more practical sense, see \ref hello.
2009-07-21 03:18:40 +00:00
*
* To learn more about the architecture:
*
* \li \ref eande
* \li \ref themes
*
* To learn more about practical development:
*
* \li \ref scglobals
* \li \ref unittests
*
* \page scglobals SCore Globals
2014-02-22 20:36:52 +00:00
*
2009-07-21 03:18:40 +00:00
* There are four global variables which are pretty essential to most extensions:
2014-02-22 20:36:52 +00:00
*
2009-07-21 03:18:40 +00:00
* \li $config -- some variety of Config subclass
* \li $database -- a Database object used to get raw SQL access
* \li $page -- a Page to holds all the loose bits of extension output
* \li $user -- the currently logged in User
*
* Each of these can be imported at the start of a function with eg "global $page, $user;"
2009-07-21 03:18:40 +00:00
*/
2012-03-30 17:03:55 +00:00
if(!file_exists("data/config/shimmie.conf.php")) {
header("Location: install.php");
exit;
}
2009-01-04 16:24:06 +00:00
try {
require_once "core/_bootstrap.inc.php";
ctx_log_start(@$_SERVER["REQUEST_URI"], true, true);
2009-01-04 16:24:06 +00:00
// start the page generation waterfall
2012-02-02 05:25:17 +00:00
$user = _get_user();
if(PHP_SAPI === 'cli') {
send_event(new CommandEvent($argv));
}
else {
send_event(new PageRequestEvent(_get_query()));
$page->display();
}
// saving cache data and profiling data to disk can happen later
if(function_exists("fastcgi_finish_request")) fastcgi_finish_request();
$database->commit();
2011-10-09 11:01:48 +00:00
ctx_log_endok();
2009-01-04 16:24:06 +00:00
}
catch(Exception $e) {
if($database) $database->rollback();
2012-02-01 15:07:03 +00:00
_fatal_error($e);
2011-10-09 11:01:48 +00:00
ctx_log_ender();
2009-01-04 16:24:06 +00:00
}