<?php

/*

 * Enano - an open-source CMS capable of wiki functions, Drupal-like sidebar blocks, and everything in between

 * Copyright (C) 2006-2009 Dan Fuhry

 * sessions.php - everything related to security and user management

 *

 * This program is Free Software; you can redistribute and/or modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied

 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.

 */

/**

 * Anything and everything related to security and user management. This includes AES encryption, which is illegal in some countries.

 * Documenting the API was not easy - I hope you folks enjoy it.

 * @package Enano

 * @subpackage Session manager

 * @category security, user management, logins, etc.

 */

class sessionManager {

  # Variables

  /**

   * Whether we're logged in or not

   * @var bool

   */

  var $user_logged_in = false;

  /**

   * Our current low-privilege session key

   * @var string

   */

  var $sid;

  /**

   * Username of currently logged-in user, or IP address if not logged in

   * @var string

   */

  var $username;

  /**

   * User ID of currently logged-in user, or 1 if not logged in

   * @var int

   */

  var $user_id = 1;

  /**

   * Real name of currently logged-in user, or blank if not logged in

   * @var string

   */

  var $real_name;

  /**

   * E-mail address of currently logged-in user, or blank if not logged in

   * @var string

   */

  var $email;

  /**

   * List of "extra" user information fields (IM handles, etc.)

   * @var array (associative)

   */

  var $user_extra;

  /**

   * User level of current user

   * USER_LEVEL_GUEST: guest

   * USER_LEVEL_MEMBER: regular user

   * USER_LEVEL_CHPREF: default - pseudo-level that allows changing password and e-mail address (requires re-authentication)

   * USER_LEVEL_MOD: moderator

   * USER_LEVEL_ADMIN: administrator

   * @var int

   */

  var $user_level;

  /**

   * High-privilege session key

   * @var string or false if not running on high-level authentication

   */

  var $sid_super;

  /**

   * The user's theme preference, defaults to $template->default_theme

   * @var string

   */

  var $theme;

  /**

   * The user's style preference, or style auto-detected based on theme if not logged in

   * @var string

   */

  var $style;

  /**

   * Signature of current user - appended to comments, etc.

   * @var string

   */

  var $signature;

  /**

   * UNIX timestamp of when we were registered, or 0 if not logged in

   * @var int

   */

  var $reg_time;

  /**

   * The number of unread private messages this user has.

   * @var int

   */

  var $unread_pms = 0;

  /**

   * AES key used to encrypt passwords and session key info.

   * @var string

   * @access private

   */

  protected $private_key;

  /**

   * Regex that defines a valid username, minus the ^ and $, these are added later

   * @var string

   */

  var $valid_username = '([^<>&\?\'"%\n\r\t\a\/]+)';

  /**

   * The current user's user title. Defaults to NULL.

   * @var string

   */

  var $user_title = null;

  /**

   * What we're allowed to do as far as permissions go. This changes based on the value of the "auth" URI param.

   * @var string

   */

  var $auth_level = 1;

  /**

   * Preference for date formatting

   * @var string

   */

  var $date_format = DATE_4;

  /**

   * Preference for time formatting

   * @var string

   */

  var $time_format = TIME_24_NS;

  /**

   * State variable to track if a session timed out

   * @var bool

   */

  var $sw_timed_out = false;

  /**

   * Token appended to some important forms to prevent CSRF.

   * @var string

   */

  var $csrf_token = false;

  /**

   * Password change disabled, for auth plugins

   * @var bool

   */

  var $password_change_disabled = false;

  /**

   * Password change page URL + title, for auth plugins

   * @var array

   */

  var $password_change_dest = array('url' => '', 'title' => '');

  /**

   * Switch to track if we're started or not.

   * @access private

   * @var bool

   */

  var $started = false;

  /**

   * Switch to control compatibility mode (for older Enano websites being upgraded)

   * @access private

   * @var bool

   */

  var $compat = false;

  /**

   * Our list of permission types.

   * @access private

   * @var array

   */

  var $acl_types = Array();

  /**

   * The list of descriptions for the permission types

   * @var array

   */

  var $acl_descs = Array();

  /**

   * A list of dependencies for ACL types.

   * @var array

   */

  var $acl_deps = Array();

  /**

   * Our tell-all list of permissions. Do not even try to change this.

   * @access private

   * @var array

   */

  var $perms = Array();

  /**

   * A cache variable - saved after sitewide permissions are checked but before page-specific permissions.

   * @var array

   * @access private

   */

  var $acl_base_cache = Array();

  /**

   * Stores the scope information for ACL types.

   * @var array

   * @access private

   */

  var $acl_scope = Array();

  /**

   * Array to track which default permissions are being used

   * @var array

   * @access private

   */

  var $acl_defaults_used = Array();

  /**

   * Array to track group membership.

   * @var array

   */

  var $groups = Array();

  /**

   * Associative array to track group modship.

   * @var array

   */

  var $group_mod = Array();

  /**

   * A constant array of user-level-to-rank default associations.

   * @var array

   */

  var $level_rank_table = array(

      USER_LEVEL_ADMIN  => RANK_ID_ADMIN,

      USER_LEVEL_MOD    => RANK_ID_MOD,

      USER_LEVEL_MEMBER => RANK_ID_MEMBER,

      USER_LEVEL_CHPREF => RANK_ID_MEMBER,

      USER_LEVEL_GUEST  => RANK_ID_GUEST

    );

  /**

   * A constant array that maps precedence constants to language strings

   * @var array

   */

  var $acl_inherit_lang_table = array(

      ACL_INHERIT_ENANO_DEFAULT   => 'acl_inherit_enano_default',

      ACL_INHERIT_GLOBAL_EVERYONE => 'acl_inherit_global_everyone',

      ACL_INHERIT_GLOBAL_GROUP    => 'acl_inherit_global_group',

      ACL_INHERIT_GLOBAL_USER     => 'acl_inherit_global_user',

      ACL_INHERIT_PG_EVERYONE     => 'acl_inherit_pg_everyone',

      ACL_INHERIT_PG_GROUP        => 'acl_inherit_pg_group',

      ACL_INHERIT_PG_USER         => 'acl_inherit_pg_user',

      ACL_INHERIT_LOCAL_EVERYONE  => 'acl_inherit_local_everyone',

      ACL_INHERIT_LOCAL_GROUP     => 'acl_inherit_local_group',

      ACL_INHERIT_LOCAL_USER      => 'acl_inherit_local_user'

    );

  # Basic functions

  /**

   * Constructor.

   */

  function __construct()

  {

    global $db, $session, $paths, $template, $plugins; // Common objects

    if ( defined('IN_ENANO_INSTALL') && !defined('IN_ENANO_UPGRADE') )

    {

      @include(ENANO_ROOT.'/config.new.php');

    }

    else

    {

      @include(ENANO_ROOT.'/config.php');

    }

    unset($dbhost, $dbname, $dbuser, $dbpasswd);

    if(isset($crypto_key))

    {

      $this->private_key = $crypto_key;

      $this->private_key = hexdecode($this->private_key);

    }

    else

    {

      if(is_writable(ENANO_ROOT.'/config.php'))

      {

        // Generate and stash a private key

        // This should only happen during an automated silent gradual migration to the new encryption platform.

        $aes = AESCrypt::singleton(AES_BITS, AES_BLOCKSIZE);

        $this->private_key = $aes->gen_readymade_key();

        $config = file_get_contents(ENANO_ROOT.'/config.php');

        if(!$config)

        {

          die('$session->__construct(): can\'t get the contents of config.php');

        }

        $config = str_replace("?>", "\$crypto_key = '{$this->private_key}';\n?>", $config);

        // And while we're at it...

        $config = str_replace('MIDGET_INSTALLED', 'ENANO_INSTALLED', $config);

        $fh = @fopen(ENANO_ROOT.'/config.php', 'w');

        if ( !$fh ) 

        {

          die('$session->__construct(): Couldn\'t open config file for writing to store the private key, I tried to avoid something like this...');

        }

        fwrite($fh, $config);

        fclose($fh);

      }

      else

      {

        die_semicritical('Crypto error', '<p>No private key was found in the config file, and we can\'t generate one because we don\'t have write access to the config file. Please CHMOD config.php to 666 or 777 and reload this page.</p>');

      }

    }

    // Check for compatibility mode

    if(defined('IN_ENANO_INSTALL'))

    {

      $q = $db->sql_query('SELECT old_encryption FROM '.table_prefix.'users LIMIT 1;');

      if(!$q)

      {

        $error = mysql_error();

        if(strstr($error, "Unknown column 'old_encryption'"))

          $this->compat = true;

        else

          $db->_die('This should never happen and is a bug - the only error that was supposed to happen here didn\'t happen. (sessions.php in constructor, during compat mode check)');

      }

      $db->free_result();

    }

  }

  /**

   * PHP 4 compatible constructor. Deprecated in 1.1.x.

   */

  /*

  function sessionManager()

  {

    $this->__construct();

  }

  */

  /**

   * Wrapper function to sanitize strings for MySQL and HTML

   * @param string $text The text to sanitize

   * @return string

   */

  function prepare_text($text)

  {

    global $db;

    return $db->escape(htmlspecialchars($text));

  }

  /**

   * Makes a SQL query and handles error checking

   * @param string $query The SQL query to make

   * @return resource

   */

  function sql($query)

  {

    global $db, $session, $paths, $template, $plugins; // Common objects

    $result = $db->sql_query($query);

    if(!$result)

    {

      $db->_die('The error seems to have occurred somewhere in the session management code.');

    }

    return $result;

  }

  /**

   * Returns true if we're currently on a page that shouldn't be blocked even if we have an inactive or banned account

   * @param bool strict - if true, whitelist of pages is even stricter (Login, Logout and CSS only). if false (default), admin access is allowed, assuming other factors allow it

   * @return bool

   */

  function on_critical_page($strict = false)

  {

    global $title;

    list($page_id, $namespace) = RenderMan::strToPageID($title);

    list($page_id) = explode('/', $page_id);

    if ( $strict )

    {

      return $namespace == 'Special' && in_array($page_id, array('CSS', 'Login', 'Logout'));

    }

    else

    {

      return $namespace == 'Admin' || ($namespace == 'Special' && in_array($page_id, array('CSS', 'Login', 'Logout', 'Administration')));

    }

  }

  # Session restoration and permissions

  /**

   * Initializes the basic state of things, including most user prefs, login data, cookie stuff

   */

  function start()

  {

    global $db, $session, $paths, $template, $plugins; // Common objects

    global $lang;

    global $timezone;

    if($this->started) return;

    $this->started = true;

    $user = false;

    if ( isset($_COOKIE['sid']) )

    {

      if ( $this->compat )

      {

        $userdata = $this->compat_validate_session($_COOKIE['sid']);

      }

      else

      {

        $userdata = $this->validate_session($_COOKIE['sid']);

      }

      if ( is_array($userdata) )

      {

        $this->sid = $_COOKIE['sid'];

        $this->user_logged_in = true;

        $this->user_id =       intval($userdata['user_id']);

        $this->username =      $userdata['username'];

        $this->user_level =    intval($userdata['user_level']);

        $this->real_name =     $userdata['real_name'];

        $this->email =         $userdata['email'];

        $this->unread_pms =    $userdata['num_pms'];

        $this->user_title =    ( isset($userdata['user_title']) ) ? $userdata['user_title'] : null;

        if(!$this->compat)

        {

          $this->theme =         $userdata['theme'];

          $this->style =         $userdata['style'];

          $this->signature =     $userdata['signature'];

          $this->reg_time =      $userdata['reg_time'];

        }

        $this->auth_level =    USER_LEVEL_MEMBER;

        // generate an anti-CSRF token

        $this->csrf_token =    sha1($this->username . $this->sid . $this->user_id);

        if(!isset($template->named_theme_list[$this->theme]))

        {

          if($this->compat || !is_object($template))

          {

            $this->theme = 'oxygen';

            $this->style = 'bleu';

          }

          else

          {

            $this->theme = $template->default_theme;

            $this->style = $template->default_style;

          }

        }

        $user = true;

        // set timezone params

        $GLOBALS['timezone'] = $userdata['user_timezone'];

        $GLOBALS['dst_params'] = explode(';', $userdata['user_dst']);

        foreach ( $GLOBALS['dst_params'] as &$parm )

        {