egroupware/phpgwapi/phpgw.inc.php

<?php
  /**************************************************************************\
  * phpGroupWare                                                             *
  * http://www.phpgroupware.org                                              *
  * This file written by Dan Kuykendall <seek3r@phpgroupware.org>            *
  * --------------------------------------------                             *
  *  This program 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 2 of the License, or (at your  *
  *  option) any later version.                                              *
  \**************************************************************************/

  /* $Id$ */
  
  $d1 = strtolower(substr($phpgw_info["server"]["api_dir"],0,3));
  $d2 = strtolower(substr($phpgw_info["server"]["server_root"],0,3));
  if($d1 == "htt" || $d1 == "ftp" || $d2 == "htt" || $d2 == "ftp") {
    echo "Failed attempt to break in via an old Security Hole!<br>\n";
    exit;
  } unset($d1);unset($d2);

  error_reporting(7);

  /**************************************************************************\
  * Quick verification of updated header.inc.php                             *
  \**************************************************************************/
  if ($phpgw_info["server"]["header_version"] != $phpgw_info["server"]["current_header_version"]){
    echo "You need to port your settings to the new header.inc.php version.";
  }

  /**************************************************************************\
  * Load up all the base files                                               *
  \**************************************************************************/
  include($phpgw_info["server"]["api_dir"] . "/phpgw_info.inc.php");

  /**************************************************************************\
  * Required classes                                                         *
  \**************************************************************************/
  /* Load selected database class */
  if (empty($phpgw_info["server"]["db_type"])){$phpgw_info["server"]["db_type"] = "mysql";}
  include($phpgw_info["server"]["api_dir"] . "/phpgw_db_".$phpgw_info["server"]["db_type"].".inc.php");

  include($phpgw_info["server"]["api_dir"] . "/phpgw_session.inc.php");

  /* Load selected translation class */
  if (empty($phpgw_info["server"]["translation_system"])){$phpgw_info["server"]["translation_system"] = "sql";}
  include($phpgw_info["server"]["api_dir"] . "/phpgw_lang_".$phpgw_info["server"]["translation_system"].".inc.php");

  include($phpgw_info["server"]["api_dir"] . "/phpgw_crypto.inc.php");
  include($phpgw_info["server"]["api_dir"] . "/phpgw_template.inc.php");
  include($phpgw_info["server"]["api_dir"] . "/phpgw_common.inc.php");

  /**************************************************************************\
  * Optional classes, which can be disabled for performance increases        *
  *  - they are loaded after pulling in the config from the DB               *
  \**************************************************************************/
  function load_optional()
  {
    global $phpgw,$phpgw_info;
 
    $phpgw->common->key  = $phpgw_info["server"]["encryptkey"];
    $phpgw->common->key .= $phpgw_info["user"]["sessionid"];
    $phpgw->common->key .= $phpgw_info["user"]["kp3"];
    $phpgw->common->iv   = $phpgw_info["server"]["mcrypt_iv"];
    $phpgw->crypto = new crypto($phpgw->common->key,$phpgw->common->iv);

    if ($phpgw_info["flags"]["enable_categories_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_categories.inc.php");
       $phpgw->categories = new categories;
    }
 
    if ($phpgw_info["flags"]["enable_network_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_network.inc.php");
       $phpgw->network = new network;
    }
   
    if ($phpgw_info["flags"]["enable_send_class"]) {
  	 include($phpgw_info["server"]["api_dir"] . "/phpgw_send.inc.php");
     $phpgw->send = new send;
    }

    if ($phpgw_info["flags"]["enable_nextmatchs_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_nextmatchs.inc.php");
       $phpgw->nextmatchs = new nextmatchs;
    }
   
    if ($phpgw_info["flags"]["enable_utilities_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_utilities.inc.php");
       $phpgw->utilities	= new utilities;
    }

    if ($phpgw_info["flags"]["enable_vfs_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_vfs.inc.php");
       $phpgw->vfs  = new vfs;
    }

    if ($phpgw_info["flags"]["enable_todo_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_todo.inc.php");
       $phpgw->todo = new todo;
    }
  
    if ($phpgw_info["flags"]["enable_calendar_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_calendar.inc.php");
       $phpgw->calendar = new calendar;
    }
  
    if ($phpgw_info["flags"]["enable_addressbook_class"]) {
       include($phpgw_info["server"]["api_dir"] . "/phpgw_addressbook.inc.php");
       $phpgw->addressbook = new addressbook;
    }
    
  } 
    
  /**************************************************************************\
  * Our API class starts here                                                *
  \**************************************************************************/
  class phpgw
  {
    var $accounts;
    var $acl;
    var $addressbook;
    var $auth;
    var $db;
    var $debug = 0;		// This will turn on debugging information. (Not fully working)
    var $crypto;
    var $calendar;
    var $categories;
    var $common;
    var $hooks;
    var $network;
    var $nextmatchs;
    var $preferences;
    var $session;
    var $msg;
    var $send;
    var $template;
    var $todo;
    var $translation;
    var $utilities;
    var $vfs;


    // This is here so you can decied what the best way to handle bad sessions
    // You could redirect them to login.php with code 2 or use the default
    // I recommend using the default until all of the bugs are worked out.

    function phpgw()
    {
      global $phpgw_info, $sessionid;
      /**************************************************************************\
      * Required classes                                                         *
      \**************************************************************************/
      $this->db           = new db;
      $this->db->Host     = $phpgw_info["server"]["db_host"];
      $this->db->Type     = $phpgw_info["server"]["db_type"];
      $this->db->Database = $phpgw_info["server"]["db_name"];
      $this->db->User     = $phpgw_info["server"]["db_user"];
      $this->db->Password = $phpgw_info["server"]["db_pass"];

      if ($this->debug) {
         $this->db->Debug = 1;
      }

      if ($phpgw_info["flags"]["currentapp"] == "login") {
         $this->db->query("select * from config",__LINE__,__FILE__);
         while($this->db->next_record()) {
           $phpgw_info["server"][$this->db->f("config_name")] = $this->db->f("config_value");
         }
      }

      /* Load selected authentication class */
      if (empty($phpgw_info["server"]["auth_type"])){$phpgw_info["server"]["auth_type"] = "sql";}
      include($phpgw_info["server"]["api_dir"] . "/phpgw_auth_".$phpgw_info["server"]["auth_type"].".inc.php");
 
      /* Load selected accounts class */
      if (empty($phpgw_info["server"]["account_repository"])){$phpgw_info["server"]["account_repository"] = $phpgw_info["server"]["auth_type"];}
      include($phpgw_info["server"]["api_dir"] . "/phpgw_accounts_".$phpgw_info["server"]["account_repository"].".inc.php");
      include($phpgw_info["server"]["api_dir"] . "/phpgw_accounts_shared.inc.php");
  
      /**************************************************************************\
      * Continue adding the classes                                              *
      \**************************************************************************/
      $this->auth          = new auth;
      $this->session       = new sessions;
      $this->translation   = new translation;
      $this->common        = new common;
      $this->accounts      = new accounts;
      $this->preferences   = new preferences;
      $this->acl           = new acl;
      $this->hooks         = new hooks;

      $sep = filesystem_separator();
      $template_root = $this->common->get_tpl_dir();

      if (is_dir($template_root)) {          
         $this->template = new Template($template_root);
      }

    } 
    /**************************************************************************\
    * Core functions                                                           *
    \**************************************************************************/

    /* A function to handle session support via url session id, or cookies */
    function link($url = "", $extravars = "")
    {
      global $phpgw, $phpgw_info, $usercookie, $kp3, $PHP_SELF;

      if (! $kp3)
         $kp3 = $phpgw_info["user"]["kp3"];

      if (! $url) {                         // PHP won't allow you to set a var to a var
         $url = $PHP_SELF;                 // or function for default values
      }

      if (isset($phpgw_info["server"]["usecookies"]) && $phpgw_info["server"]["usecookies"]) {
         if ($extravars) {
            $url .= "?$extravars";
         }
      } else {
        $url .= "?sessionid=" . $phpgw_info["user"]["sessionid"];
        $url .= "&kp3=" . $kp3;
        if ($extravars) {
          $url .= "&$extravars";
        }
        $url .= "&domain=" . $phpgw_info["user"]["domain"];
        if ($phpgw_info["flags"]["newsmode"]) {
          $url .= "&newsmode=on";
        }
      }

      // next line adds index.php when one is assumed since
      // iis will not interpret urls like http://.../addressbook/?xyz=5
      return str_replace("/?", "/index.php?", $url);
    }  

    function strip_html($s)
    {
       global $phpgw_info;
       $working_langs = array("en" => True);

       return htmlspecialchars(stripslashes($s));
    }

    function redirect($url = "")
    {
      // This function handles redirects under iis and apache
      // it assumes that $phpgw->link() has already been called

      global $HTTP_ENV_VARS;

      $iis = strpos($HTTP_ENV_VARS["SERVER_SOFTWARE"], "IIS", 0);
      
      if ( !$url ) {
        $url = $PHP_SELF;
      }
      if ( $iis ) {
        echo "\n<HTML>\n<HEAD>\n<TITLE>Redirecting to $url</TITLE>";
        echo "\n<META HTTP-EQUIV=REFRESH CONTENT=\"0; URL=$url\">";
        echo "\n</HEAD><BODY>";
        echo "<H3>Please continue to <a href=\"$url\">this page</a></H3>";
        echo "\n</BODY></HTML>";
        exit;
      } else {
        Header("Location: $url");
        print("\n\n");
        exit;
      }
    }

    function lang($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "") 
    {
      global $phpgw;
      
      return $phpgw->translation->translate($key);
    }

    // Some people might prefear to use this one
    function _L($key, $m1 = "", $m2 = "", $m3 = "", $m4 = "") 
    {
      global $phpgw;
      
      return $phpgw->translation->translate($key);
    }


  }
  /**************************************************************************\
  * Our API class ends here                                                  *
  \**************************************************************************/
  /**************************************************************************\
  * Direct functions, which are not part of the API class                    *
  * for whatever reason.                                                     *
  \**************************************************************************/
  
  function lang($key, $m1="", $m2="", $m3="", $m4="", $m5="", $m6="", $m7="", $m8="", $m9="", $m10=""  ) 
  {
    global $phpgw;
# TODO: check if $m1 is of type array. If so, use it instead of $m2-$mN (Stephan)
    $vars = array( $m1, $m2, $m3, $m4, $m5, $m6, $m7, $m8, $m9, $m10 );
    $value = $phpgw->translation->translate("$key", $vars );
    return $value;
  }


  // Just a temp wrapper.
  function check_code($code)
  {
    global $phpgw;
  
    return $phpgw->common->check_code($code);
  }

  /**************************************************************************\
  * These lines load up the API, fill up the $phpgw_info array, etc          *
  \**************************************************************************/
  $phpgw = new phpgw;

  if ($phpgw_info["flags"]["currentapp"] != "login" && $phpgw_info["flags"]["currentapp"] != "logout") {
     if (! $phpgw->session->verify()) {
        Header("Location: " . $phpgw->link($phpgw_info["server"]["webserver_url"] . "/login.php", "cd=10"));
        exit;
     }
     load_optional();

     phpgw_fillarray();
     $phpgw->common->common_();
     if ($phpgw_info["flags"]["enable_calendar_class"]){
       $printer_friendly = ((isset($friendly) && ($friendly==1))?True:False);
       $phpgw->calendar->calendar_($printer_friendly);
     }
     if ($phpgw_info["flags"]["enable_utilities_class"]){
        $phpgw->utilities->utilities_();
     }

    if (!isset($phpgw_info["flags"]["nocommon_preferences"]) || !$phpgw_info["flags"]["nocommon_preferences"]) {
      if (!isset($phpgw_info["user"]["preferences"]["common"]["maxmatchs"]) || !$phpgw_info["user"]["preferences"]["common"]["maxmatchs"]) {
         $phpgw->preferences->change("common","maxmatchs",15);
         $preferences_update = True;
      }
      if (!isset($phpgw_info["user"]["preferences"]["common"]["theme"]) || !$phpgw_info["user"]["preferences"]["common"]["theme"]) {
         $phpgw->preferences->change("common","theme","default");
         $preferences_update = True;
      }
      if (!isset($phpgw_info["user"]["preferences"]["common"]["dateformat"]) || !$phpgw_info["user"]["preferences"]["common"]["dateformat"]) {
         $phpgw->preferences->change("common","dateformat","m/d/Y");
         $preferences_update = True;
      }
      if (!isset($phpgw_info["user"]["preferences"]["common"]["timeformat"]) || !$phpgw_info["user"]["preferences"]["common"]["timeformat"]) {
         $phpgw->preferences->change("common","timeformat",12);
         $preferences_update = True;
      }
      if (!isset($phpgw_info["user"]["preferences"]["common"]["lang"]) || !$phpgw_info["user"]["preferences"]["common"]["lang"]) {
         $phpgw->preferences->change("common","lang","en");
         $preferences_update = True;
      }
      if ($preferences_update) {
         $phpgw->preferences->commit(__LINE__,__FILE__);
      }
      unset($preferences_update);
    }

     /**************************************************************************\
     * These lines load up the themes                                           *
     \**************************************************************************/
     include($phpgw_info["server"]["api_dir"] . "/themes/" .
	        $phpgw_info["user"]["preferences"]["common"]["theme"] . ".theme");

     if ($phpgw_info["theme"]["bg_color"] == "") {
        /* Looks like there was a problem finding that theme. Try the default */
        echo "Warning: error locating selected theme";
        include ($phpgw_info["server"]["api_dir"] . "/themes/default.theme");
        if ($phpgw_info["theme"]["bg_color"] == "") {
           // Hope we don't get to this point.  Better then the user seeing a 
           // complety back screen and not know whats going on
           echo "<body bgcolor=FFFFFF>Fatal error: no themes found";
           exit;
        }
     }

     /**************************************************************************\
     * If they are using frames, we need to set some variables                  *
     \**************************************************************************/
     if (($phpgw_info["user"]["preferences"]["common"]["useframes"] && $phpgw_info["server"]["useframes"] == "allowed")
        || ($phpgw_info["server"]["useframes"] == "always")) {
        $phpgw_info["flags"]["navbar_target"] = "phpgw_body";
     }

     /**************************************************************************\
     * Verify that the users session is still active otherwise kick them out    *
     \**************************************************************************/
     if ($phpgw_info["flags"]["currentapp"] != "home" && $phpgw_info["flags"]["currentapp"] != "logout"
        && $phpgw_info["flags"]["currentapp"] != "preferences") {

        if (! $phpgw_info["user"]["apps"][$phpgw_info["flags"]["currentapp"]]) {
           $phpgw->common->phpgw_header();
           echo "<p><center><b>" . lang("Access not permitted") . "</b></center>";
           exit;
        }
     }

     /**************************************************************************\
     * Load the header unless the developer turns it off                        *
     \**************************************************************************/
     if (!isset($phpgw_info["flags"]["noheader"]) || ! $phpgw_info["flags"]["noheader"]) {
        $phpgw->common->phpgw_header();
     }

     /**************************************************************************\
     * Load the app include files if the exists                                 *
     \**************************************************************************/
     /* Then the include file */
     if (file_exists ($phpgw_info["server"]["app_inc"]."/functions.inc.php")){
        include($phpgw_info["server"]["app_inc"]."/functions.inc.php");
     }
  }
  error_reporting(7);