Nephthys

 <?php

 /***************************************************************************

  *

  * Nephthys - file sharing management

  * Copyright (c) by Andreas Unterkircher, unki@netshadow.at

  *

  *  This file is part of Nephthys.

  *

  *  Nephthys is free software: you can redistribute it and/or modify

  *  it under the terms of the GNU General Public License as published by

  *  the Free Software Foundation, either version 3 of the License, or

  *  (at your option) any later version.

  *

  *  Nephthys 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 more details.

  *

  *  You should have received a copy of the GNU General Public License

  *  along with Nephthys. If not, see <http://www.gnu.org/licenses/>.

  *

  ***************************************************************************/

 require_once "nephthys_db.php";

 require_once "nephthys_buckets.php";

 require_once "nephthys_addressbook.php";

 require_once "nephthys_users.php";

 require_once "nephthys_profile.php";

 require_once "nephthys_upload.php";

 class NEPHTHYS {

    public $cfg;

    public $db;

    public $tmpl;

    public $current_user;

    public $browser_info;

    public $sort_order;

    private $runtime_error = false;

    private $_translationTable;        // currently loaded translation table

    private $_loadedTranslationTables; // array of all loaded translation tables

    /**

     * class constructor

     *

     * this function will be called on class construct

     * and will check requirements, loads configuration,

     * open databases and start the user session

     */

    public function __construct()

    {

       $GLOBALS['nephthys'] =& $this;

       /* load config, exit if it fails */

       if(!$this->load_config()) {

          $this->_error("Error during load_config()");

          exit(1);

       }

       // if servername has not been set in the configuration

       // get it from the webserver. Only necessary if not

       // called from command line.

       if(!isset($this->cfg->servername) && !$this->is_cmdline()) {

          if(!isset($_SERVER['SERVER_NAME']))

             die("Can't get server name out of \$_SERVER['SERVER_NAME']");

          $this->cfg->servername = $_SERVER['SERVER_NAME'];

       }

       /* Check necessary requirements */

       if(!$this->checkRequirements()) {

          exit(1);

       }

       $this->browser_info = new Net_UserAgent_Detect();

       /* verify if browser supports javascript

            ... if not called from command line

            ... if not called via RPC handler

            ... and ignore Javascript check is not set

       */

       if(!$this->is_cmdline() && !defined('RPC_CALL') && (!isset($this->cfg->ignore_js) || empty($this->cfg->ignore_js))) {

          if(!$this->browser_info->hasFeature('javascript')) {

             $this->_error("It seems your browser is not capable of supporting JavaScript or it has been disabled.");

             $this->_error("Nephthys will not work without JavaScript!");

             exit;

          }

       }

       /* if database type is set to sqlite, database exists

          but is not readable ...

       */

       if($this->cfg->db_type == "sqlite" &&

          file_exists($this->cfg->sqlite_path) &&

          !is_readable($this->cfg->sqlite_path)) {

          $this->_error("[". $this->cfg->sqlite_path ."] SQLite database is not readable for user ". $this->getuid());

          exit(1);

       }

       /* if database type is set to sqlite, database exists

          but is not writeable ...

       */

       if($this->cfg->db_type == "sqlite" &&

          file_exists($this->cfg->sqlite_path) &&

          !is_writable($this->cfg->sqlite_path)) {

          $this->_error("[". $this->cfg->sqlite_path ."] SQLite database is not writeable for user ". $this->getuid());

          exit(1);

       }

       /* if database type is set to sqlite, database does not exist

          yet and directory to store database is not writeable...

       */

       if($this->cfg->db_type == "sqlite" &&

          !file_exists($this->cfg->sqlite_path) &&

          !is_writable(dirname($this->cfg->sqlite_path))) {

          $this->_error("[". $this->cfg->sqlite_path ."] SQLite database can not be created in directory by user ". $this->getuid());

          exit(1);

       }

       $this->db  = new NEPHTHYS_DB();

       $this->check_db_tables();

       if(!is_writable($this->cfg->tmpl_path ."/templates_c")) {

          $this->_error("[". $this->cfg->tmpl_path ."/templates_c] directory is not writeable for user ". $this->getuid());

          exit(1);

       }

       /* check if the bucket root directory ($data_path) exists */

       if(!file_exists($this->cfg->data_path)) {

          $this->_error("[". $this->cfg->data_path ."] directory does not exist");

          exit(1);

       }

       /* check if the webservers user is allowed to modify the bucket

          root directory ($data_path). This is necessary to create &

          delete bucket directories.

       */

       if(!is_writeable($this->cfg->data_path)) {

          $this->_error("[". $this->cfg->data_path ."] directory is not writeable for user ". $this->getuid());

          exit(1);

       }

       /* if session is not yet started, do it now */

       if(session_id() == "")

          session_start();

       /*if(!isset($_SERVER['REMOTE_USER']) || empty($_SERVER['REMOTE_USER'])) {

          $this->parent->_error("It seems you are not authenticated through the server");

          exit(1);

       }

       */

       if(!$this->is_cmdline() &&

          isset($this->cfg->allow_server_auth) && $this->cfg->allow_server_auth == true

          && (!isset($_SERVER['REMOTE_USER']) || empty($_SERVER['REMOTE_USER']))) {

          $this->_error("Server authentication is enabled in Nephthys config but server does not "

             ."provide details in REMOTE_USER variable.");

          exit(1);

       }

       /* if server-authentication is allowed... */

       if(isset($this->cfg->allow_server_auth) &&

          $this->cfg->allow_server_auth == true) {

          /* if the user exists in Nephthys user table ... */

          if(isset($_SERVER['REMOTE_USER']) && $user = $this->get_user_details_by_name($_SERVER['REMOTE_USER'])) {

             /* if user is active, register informations to session */

             if($user->user_active == 'Y') {

                $_SESSION['login_name'] = $user->user_name;

                $_SESSION['login_idx'] = $user->user_idx;

                /* update the last login time of this user */

                $this->update_last_login($user->user_idx);

             }

          }

          /* otherwise, if auto-creation is enabled, create it... */

          else {

             /* is user-auto-creation enabled? */

             if(isset($this->cfg->user_auto_create) &&

                $this->cfg->user_auto_create == true) {

                if(isset($_SERVER['REMOTE_USER']) &&

                   $idx = $this->create_user($_SERVER['REMOTE_USER'])) {

                   if($user = $this->get_user_details_by_idx($idx)) {

                      $_SESSION['login_name'] = $user->user_name;

                      $_SESSION['login_idx'] = $user->user_idx;

                      /* update the last login time of this user */

                      $this->update_last_login($user->user_idx);

                   }

                }

             }

          }

       }

       else {

          /* local authentication, if login data is already available */

          if(isset($_SESSION['login_idx']) && is_numeric($_SESSION['login_idx']))

             $user = $this->get_user_details_by_idx($_SESSION['login_idx']);

       }

       /* if the user-object was found in database (or has been auto-created)

          and the user has selected its own prefered language...

       */

       if(isset($user) &&

          isset($user->user_language) &&

          !empty($user->user_language) &&

          in_array($user->user_language, array_keys($this->cfg->avail_langs))) {

          $this->cfg->language = $user->user_language;

       }

       /* load translation table for the current language */

       $this->load_translation_table();

       /* overload Smarty class if our own template handler */

       require_once "nephthys_tmpl.php";

       $this->tmpl = new NEPHTHYS_TMPL();

       if(isset($user->user_email) && !empty($user->user_email))

          $this->tmpl->assign('login_email', $user->user_email);

       /* if browser is type Internet Explorer set a template variable to

          inidicate to templates that browser is IE.

       */

       if(isset($this->browser_info) && $this->browser_info->isIE())

          $this->tmpl->assign('is_ie', true);

       if($this->browser_info->getOS(array("vista", "win7"))) {

          $this->tmpl->assign('is_vista', true);

       }

       $this->tmpl->assign('hide_logout', $this->cfg->hide_logout);

       $this->tmpl->assign('disk_used', $this->get_unit($this->get_used_diskspace()));

       $this->tmpl->assign('disk_free', $this->get_unit($this->get_free_diskspace()));

       /* pre-define default sort order, if not set yet */

       if(!isset($_SESSION['sort_order']) || !is_array($_SESSION['sort_order'])) {

          $_SESSION['sort_order'] = Array(

             'buckets' => Array(

                'column' => 'bucket_name',

                'order' => 'asc'),

             'addressbook' => Array(

                'column' => 'contact_name',

                'order' => 'asc'),

             'users' => Array(

                'column' => 'user_name',

                'order' => 'asc'),

          );

       }

    } // __construct()

    public function __destruct()

    {

    } // __destruct()

    /**

     * init - generate html output

     *

     * this function can be called after the constructor has prepared

     * everyhing. it will load the index.tpl Smarty template and exit

     * successfully.

     */

    public function init()

    {

       print $this->tmpl->fetch("index.tpl");

       exit(0);

    } // init()

    /**

     * outputs the main content template

     */

    public function show()

    {

       return $this->tmpl->fetch("main.tpl");

    } // show()

    /**

     * outputs the menu template()

     */

    public function get_menu()

    {

       return $this->tmpl->fetch("menu.tpl");

    } // get_menu()

    /**

     * return main content

     */

    public function get_content()

    {

       /* if no user-login yet, show the login box */

       if(!$this->is_logged_in()) {

          return $this->tmpl->fetch("login_box.tpl");

       }

       else {

          /* if the user has been auto-created, but its email address has not

             been set yet - and the nephthys config option

                $force_profile_update

             is set to true, forward the user to the profile page instead of

             everything else.

          */

          if(isset($this->cfg->force_profile_update) &&

             !empty($this->cfg->force_profile_update) &&

             $this->is_auto_created($_SESSION['login_idx']) &&

             !$this->get_user_email($_SESSION['login_idx'])) {

             $request = "profile";

          }

       }

       /* if the requests has not been overruled yet */

       if(!isset($request)) {

          /* page-id via HTTP GET */

          if(isset($_GET['id']) && is_string($_GET['id']))

             $request = $_GET['id'];

          /* page-id via HTTP POST */

          if(isset($_POST['id']) && is_string($_POST['id']))

             $request = $_POST['id'];

       }

       switch($request) {

          case 'main':

             $obj = $this;

             break;

          case 'users':

             $obj = new NEPHTHYS_USERS();

             break;

          case 'buckets':

             $obj = new NEPHTHYS_BUCKETS();

             break;

          case 'profile':

             $obj = new NEPHTHYS_PROFILE();

             break;

          case 'addressbook':

             $obj = new NEPHTHYS_ADDRESSBOOK();

             break;

          case 'about':

             return $this->tmpl->fetch("about.tpl");

             break;

          case 'help':

             return $this->tmpl->fetch("help.tpl");

             break;

          case 'savedbucket':

             $obj = new NEPHTHYS_BUCKETS();

             return $obj->showBucket();

             break;

       }

       if(isset($obj))

          return $obj->show();

    } // get_content()

    public function store()

    {

       if(!$this->is_logged_in()) {

          return "login first";

       }

       if(isset($_POST['module'])) {

          switch($_POST['module']) {

             case 'users':

                $obj = new NEPHTHYS_USERS;

                break;

             case 'buckets':

                $obj = new NEPHTHYS_BUCKETS;

                break;

             case 'profile':

                $obj = new NEPHTHYS_PROFILE;

                break;

             case 'addressbook':

                $obj = new NEPHTHYS_ADDRESSBOOK;

                break;

             default:

                return "unkown module";

                break;

          }

          if(isset($obj)) {

             switch($_POST['mode']) {

                case 'modify': return $obj->store(); break;

                case 'delete': return $obj->delete(); break;

                case 'toggle': return $obj->toggleStatus(); break;

             }

          }

       }

    } // store()

    /**

     * check if all requirements are met

     */

    private function checkRequirements()

    {

       /* Check for HTML_AJAX PEAR package, lent from Horde project */

       ini_set('track_errors', 1);

       @include_once 'HTML/AJAX/Server.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("PEAR HTML_AJAX package is missing");

          $missing = true;

       }

       @include_once 'MDB2.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("PEAR MDB2 package is missing");

          $missing = true;

          unset($php_errormsg);

       }

       // If database type is set to MySQL

       if($this->cfg->db_type == "mysql") {

          @include_once 'MDB2/Driver/mysqli.php';

          if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

             $this->_error("PEAR MDB2-mysqli package is missing");

             $missing = true;

             unset($php_errormsg);

          }

       }

       // If database type is set to SQLite

       if($this->cfg->db_type == "sqlite") {

           @include_once 'MDB2/Driver/sqlite.php';

          if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

             $this->_error("PEAR MDB2-sqlite package is missing");

             $missing = true;

             unset($php_errormsg);

          }

       }

       @include_once 'Mail.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("PEAR Mail package is missing");

          $missing = true;

          unset($php_errormsg);

       }

       @include_once 'Net/UserAgent/Detect.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("PEAR Net_UserAgent_Detect package is missing");

          $missing = true;

          unset($php_errormsg);

       }

       @include_once 'Console/Getopt.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("PEAR Console_Getopt package is missing");

          $missing = true;

          unset($php_errormsg);

       }

       @include_once $this->cfg->smarty_path .'/libs/Smarty.class.php';

       if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) {

          $this->_error("Smarty template engine can not be found in ". $this->cfg->smarty_path ."/libs/Smarty.class.php");

          $missing = true;

          unset($php_errormsg);

       }

       ini_restore('track_errors');

       if(isset($missing))

          return false;

       return true;

    } // checkRequirements()

    /**

     * return the type of protocol used

     *

     * this function returns wether HTTP or HTTPS

     * is used for the client connection.

     *

     * @return string

     */

    private function get_web_protocol()

    {

       if(!isset($_SERVER['HTTPS']))

          return "http";

       else

          return "https";

    } // get_web_protocol()

    /**

     * return url to this installation

     *

     * @return string

     */

    private function get_nephthys_url()

    {

       return $this->get_web_protocol() ."://". $this->get_server_name() . $this->cfg->web_path;

    } // get_nephthys_url()

    /**

     * check file exists and is readable

     *

     * returns true, if everything is ok, otherwise false

     * if $silent is not set, this function will output and

     * error message

     */

    private function check_readable($file, $silent = null)

    {

       if(!file_exists($file)) {

          if(!isset($silent))

             print "File \"". $file ."\" does not exist.\n";

          return false;

       }

       if(!is_readable($file)) {

          if(!isset($silent))

             print "File \"". $file ."\" is not reachable for user ". $this->getuid() ."\n";

          return false;

       }

       return true;

    } // check_readable()

    /**

     * validate config options

     *

     * this function checks if all necessary configuration options are

     * specified and set.

     */

    private function check_config_options()

    {

       if(!isset($this->cfg->page_title) || $this->cfg->page_title == "")

          $this->_error("Please set \$page_title in nephthys_cfg");

       if(!isset($this->cfg->base_path) || $this->cfg->base_path == "")

          $this->_error("Please set \$base_path in nephthys_cfg");

       if(!isset($this->cfg->web_path) || $this->cfg->web_path == "")

          $this->_error("Please set \$web_path in nephthys_cfg");

       if(!isset($this->cfg->smarty_path) || $this->cfg->smarty_path == "")

          $this->_error("Please set \$smarty_path in nephthys_cfg");

       if(!isset($this->cfg->theme_name))

          $this->_error("Please set \$theme_name in nephthys_cfg");

       if(!isset($this->cfg->mysql_host))

          $this->_error("Please set \$mysql_host in nephthys_cfg");

       if(!isset($this->cfg->mysql_db))

          $this->_error("Please set \$mysql_db in nephthys_cfg");

       if(!isset($this->cfg->mysql_user))

          $this->_error("Please set \$mysql_user in nephthys_cfg");

       if(!isset($this->cfg->mysql_pass))

          $this->_error("Please set \$mysql_pas in nephthys_cfg");

       if(!isset($this->cfg->logging))

          $this->_error("Please set \$logging in nephthys_cfg");

       if(isset($this->cfg->logging) && $this->cfg->logging == 'logfile') {

          if(!isset($this->cfg->log_file))

             $this->_error("Please set \$log_file because you set logging = log_file in nephthys_cfg");

          if(!is_writable($this->cfg->log_file))

             $this->_error("The specified \$log_file ". $log_file ." is not writeable!");

       }

       /* check for pending slash on web_path */

       if(!preg_match("/\/$/", $this->cfg->web_path))

          $this->cfg->web_path.= "/";

       return $this->runtime_error;

    } // check_config_options()

    /**

     * return the current process-user

     */

    private function getuid()

    {

       if($uid = posix_getuid()) {

          if($user = posix_getpwuid($uid)) {

             return $user['name'];

          }

       }

       return 'n/a';

    } // getuid()

    /**

     * returns the email address of the provided user id

     * @param int $user_idx

     * @return string

     */

    public function get_user_email($user_idx)

    {

       $row = $this->db->db_fetchSingleRow("

          SELECT

             user_email

          FROM

             nephthys_users

          WHERE

             user_idx='". $user_idx ."'

       ");

       if(isset($row->user_email)) {

          return $row->user_email;

       }

       return NULL;

    } // get_user_email()

    /**

     * return current users email address

     *

     * this function returns the email address of the

     * currently logged in user.

     * @return string

     */

    public function get_my_email()

    {

       /* if no user is logged in yet, return */

       if(!isset($_SESSION['login_name']))

          return NULL;

       $row = $this->db->db_fetchSingleRow("

          SELECT user_email

          FROM nephthys_users

          WHERE user_name LIKE '". $_SESSION['login_name'] ."'

       ");

       if(isset($row->user_email)) {

          return $row->user_email;

       }

       return NULL;

    } // get_my_email()

    /**

     * return all user details for the provided user_name

     */

    private function get_user_details_by_name($user_name)

    {

       if($user = $this->db->db_fetchSingleRow("

          SELECT *

          FROM nephthys_users

          WHERE

             user_name LIKE '". $user_name ."'")) {

          return $user;

       }

       return NULL;

    } // get_user_detail_by_name()

    /**

     * return all user details for the provided user_idx

     */

    private function get_user_details_by_idx($user_idx)

    {

       if($user = $this->db->db_fetchSingleRow("

          SELECT *

          FROM nephthys_users

          WHERE

             user_idx LIKE '". $user_idx ."'")) {

          return $user;

       }

       return NULL;

    } // get_user_details()

    /**

     * returns user name

     *

     * @return string

     */

    public function get_user_name($user_idx)

    {

       if($user = $this->get_user_details_by_idx($user_idx)) {

          return $user->user_name;

       }

       return NULL;

    } // get_user_name()

    /**

     * return the specified users full name

     *

     * @return string

     */

    public function get_user_fullname($user_idx)

    {

       if($user = $this->get_user_details_by_idx($user_idx)) {

          return $user->user_full_name;

       }

       return NULL;

    } // get_user_fullname()

    /**

     * returns user privilege

     */

    public function get_user_priv($user_idx)

    {

       if($user = $this->get_user_details_by_idx($user_idx)) {

          return $user->user_priv;

       }

       return NULL;

    } // get_user_priv()

    /**

     * returns users default expiration time

     */

    public function get_user_expire($user_idx)

    {

       if($user = $this->get_user_details_by_idx($user_idx)) {

          return $user->user_default_expire;

       }

       return NULL;

    } // get_user_expire()

    /**

     * returns true if a user is logged in, otherwise false

     */

    public function is_logged_in()

    {

       if(isset($_SESSION['login_name']) && !empty($_SESSION['login_name']) &&

          $this->is_valid_user($_SESSION['login_name'])) {

          return true;

       }

       return false;

    } // is_logged_in()

    /**

     * return true if the user exists

     */

    private function is_valid_user($user_name)

    {

       if($this->db->db_fetchSingleRow("

             SELECT user_idx

             FROM nephthys_users

             WHERE user_name LIKE '". $user_name ."'

          ")) {

          return true;

       }

       return false;

    } // is_valid_user()

    /***

     * validates all provided email addresses.

     * multiple email addresses are seperated by comma

     *

     * @param string $email

     * @return boolean

     */

    public function is_valid_email($email)

    {

       /* only one email address? */

       if(strstr($email, ',') === false)

          return $this->validate_email($email);

       /* multiple email addresses */

       $emails = preg_split("/,/", $email);

       if(!is_array($emails) || empty($emails))

          return false;

       foreach($emails as $email_addr) {

          $email_addr = trim($email_addr);

          /* return as soon as an invalid address has been found */

          if(!$this->validate_email($email_addr))

             return false;

       }

       return true;

    } // is_valid_email()

    /***

     * verify email address

     *

     * found on: http://www.ilovejackdaniels.com/php/email-address-validation/

    */

    public function validate_email($email)

    {

       /* if email has been entered in the format

             fullname <email-address>

          then we need to extract the address first

       */

       if(preg_match('/^(.+)\s\<(.+)\>/', $email, $matches)) {

          $email = $matches[2];

       }

       //if php version < 5.2