smf.plugin.php

Go to the documentation of this file.

<?php

include_once("embient.plugin.php");

function embient_create_smf_plugin()
{
  return new EmbientSMF();
}

function embient_smf_encrypt($username, $password)
{
  return sha1(strtolower($username) . $password);
}

function embient_smf_salt()
{
  return substr(md5(rand()), 0, 4);
}

function embient_smf_parse_url($local = false, $global = false)
{
  // Parse the URL with PHP to make life easier.
  $parsed_url = parse_url($this->conf['boardurl']);

  // Is local cookies off?
  if (empty($parsed_url['path']) || !$local)
  {
    $parsed_url['path'] = '';
  }

  // Globalize cookies across domains (filter out IP-addresses)?
  if ($global && preg_match('~^\d{1,3}(\.\d{1,3}){3}$~', $parsed_url['host']) == 0)
  {
    // If we can't figure it out, just skip it.
    if (preg_match('~(?:[^\.]+\.)?([^\.]{2,}\..+)\z~i', $parsed_url['host'], $parts) == 1)
    {
      $parsed_url['host'] = '.' . $parts[1];
    }
  }
  else if (!$local) // We shouldn't use a host at all if both options are off.
  {
    $parsed_url['host'] = '';
  }

  return array($parsed_url['host'], $parsed_url['path'] . '/');
}


class EmbientSMF extends EmbientPlugin
{
  var $conf;

  var $settings;

  // -------------------------

  function EmbientSMF()
  {
    $this->EmbientPlugin('smf');

    // user field mapping for SMF
    $this->_mapping = array
    (
      'name'      => 'memberName',
      'passwd'    => 'passwd',
      'mail'      => 'emailAddress',
      'signature' => 'signature',
      'timezone'  => 'timeOffset',
    );
  }

  function Init($cfg)
  {
    @set_magic_quotes_runtime(0);
    require_once($cfg['root']['value'] ."/Settings.php");

    // load settings to class's properties
    $this->conf['maintenance'] = $maintenance;
    $this->conf['mtitle']      = $mtitle;
    $this->conf['mmessage']    = $mmessage;

    $this->conf['mbname']          = $mbname;
    $this->conf['language']        = $language;
    $this->conf['boardurl']        = $boardurl;
    $this->conf['webmaster_email'] = $webmaster_email;
    $this->conf['cookiename']      = $cookiename;

    $this->conf['db_server']     = $db_server;
    $this->conf['db_name']       = $db_name;
    $this->conf['db_user']       = $db_user;
    $this->conf['db_passwd']     = $db_passwd;
    $this->conf['db_prefix']     = $db_prefix;
    $this->conf['db_persist']    = $db_persist;
    $this->conf['db_error_send'] = $db_error_send;

    $this->conf['boarddir']  = $boarddir;
    $this->conf['sourcedir'] = $sourcedir;

    $this->conf['db_last_error'] = $db_last_error;

    // If $maintenance is set to 2, don't connect to the database at all.
    if ($this->conf['maintenance'] == 2)
    {
      embient_error('SMF system is under maintenance, cannot connect to its database', __FILE__, __LINE__);
      return false;
    }

    // load database params
    $db_params = array(
                  'db_host'   => $this->conf['db_server'],
                  'db_user'   => $this->conf['db_user'],
                  'db_passwd' => $this->conf['db_passwd'],
                  'db_name'   => $this->conf['db_name'],
                  'prefix'    => $this->conf['db_prefix'],
                 );

    // connect to database
    if ( ! parent::Init($db_params) )
    {
      return false;
    }

    // load settings from database
    $query = "SELECT variable, value FROM {settings}";

    if ( ! $this->_db->Query($query, __FILE__, __LINE__) )
    {
      return false;
    }

    $this->settings = array();

    $rows = $this->_db->GetRowsCount();

    for ( $i = 0; $i < $rows; $i++ )
    {
      $setting = $this->_db->FetchArray();
      $this->settings[$setting['variable']] = $setting['value'];
    }

    return ! empty($this->settings);
  }
  
  function Login($username)
  {
    if ( ! $this->_Load($username) )
    {
      embient_error("User ". $username ." cannot be loaded", __FILE__, __LINE__);
    }

    // they've got no salt; fix it!
    if ( $this->user['passwordSalt'] == '' )
    {
      $this->user['passwordSalt'] = embient_smf_salt();
      $this->Update($username, $this->user);
    }

    // load user groups information
        if ( empty($this->user['additionalGroups']) )
    {
            $this->user['groups'] = array($this->user['ID_GROUP'], $this->user['ID_POST_GROUP']);
    }
        else
    {
            $this->user['groups'] = array_merge(
                array($this->user['ID_GROUP'], $this->user['ID_POST_GROUP']),
                explode(',', $this->user['additionalGroups'])
            );
    }

    // This might be set to "forum default"...
    if (empty($this->user['timeFormat']))
    {
      $this->user['timeFormat'] = $this->settings['time_format'];
    }

    // delete previous one
    if (isset($_COOKIE[$this->conf['cookiename']]))
    {
      $array = @unserialize($_COOKIE[$this->conf['cookiename']]);

      // Out with the old, in with the new!
      if (isset($array[3]) && $array[3] != $cookie_state)
      {
        $cookie_url = embient_smf_parse_url($array[3] & 1 > 0, $array[3] & 2 > 0);
        setcookie($this->conf['cookiename'], serialize(array(0, '', 0)), time() - 3600, $cookie_url[1], $cookie_url[0], 0);
      }
    }

    // set new one
    $cookie_state  = (empty($this->settings['localCookies']) ? 0 : 1) | (empty($this->settings['globalCookies']) ? 0 : 2);
    $cookie_url    = embient_smf_parse_url(!empty($this->settings['localCookies']), !empty($this->settings['globalCookies']));
    $cookie_time   = time() + ($this->settings['cookieTime'] * 60);
    $cookie_passwd = sha1($this->user['passwd'] . $this->user['passwordSalt']); // encrypt the cookie

    $cookie_data   = serialize(array($this->user['ID_MEMBER'], $cookie_passwd, $cookie_time, $cookie_state));

    setcookie($this->conf['cookiename'], $cookie_data, $cookie_time, $cookie_url[1], $cookie_url[0], 0);
    $_COOKIE[$this->conf['cookiename']] = $cookie_data;

    $this->_LogAction("Browsing main site");

    $query = "UPDATE {members} "
           .   "SET "
           .     "lastLogin = '". time() ."', "
           .     "memberIP = IFNULL('". $_SERVER[REMOTE_ADDR] ."', '') "
           .   "WHERE ID_MEMBER = '". $this->user['ID_MEMBER'] ."'";

    $this->_db->Query($query, __FILE__, __LINE__);
  }

  function Logout($username)
  {
    // remove cookie
    $cookie_data = serialize(array(0, '', 0));
    $cookie_url  = embient_smf_parse_url($this->settings['localCookies'], $this->settings['globalCookies']);

    setcookie($this->conf['cookiename'], $cookie_data, time() - 3600, $cookie_url[1], $cookie_url[0], 0);
    $_COOKIE[$this->conf['cookiename']] = $cookie_data;

    // delete session info in database
    $query = "DELETE FROM {sessions} "
           . "WHERE session_id = '". $_COOKIE[ini_get('session.name')] ."';";

    $this->_db->Query($query, __FILE__, __LINE__);

    // clear action
    $this->_LogAction();

    // clear user info
    $this->user = array();
  }

  function Add($user)
  {
    // initialise the user info
    $this->user = Array();
    $this->_ConvertUserInfo($user);

    // encrypt password
    $this->user['passwd'] = embient_smf_encrypt($this->user['memberName'], $this->user['passwd']);

    // format query
    $val = '';
    foreach( $this->user as $v)
    {
      $val = $val.($val != '' ? ', ' : '')."'$v'";
    }    

    $query = "INSERT INTO {members} "
                 . "(" . implode(', ', array_keys($this->user)) . ") "
           . "VALUES (". $val .')';

    $this->_db->Query($query, __FILE__, __LINE__);
  }

  function Update($username, $user)
  {
    // get database key for this user
    if ( ! $this->_Load($username) )
    {
      return;
    }

    $uid = $this->user['ID_MEMBER'];

    // if new user name or password is supplied, re-encrypt the password
    $newpass = '';
    if ( $user['name'] != $username || ! empty($user['passwd']) )
    {
      $newpass = embient_smf_encrypt($user['name'], $user['passwd']);
    }

    // load value
    $this->user = Array();                 // clear buffer
    $this->_ConvertUserInfo($user, false); // not load default

    // load new encrpyted password, if available
    if ( ! empty($newpass) )
    {
      $this->user['passwd'] = $newpass;
    }

    // create query
    $fields = array();

    foreach ($this->user as $key => $val)
    {
      array_push($fields, "$key = '$val'");
    }

    $query = "UPDATE {members} "
           . "SET "
           . implode(', ', $fields) ." "
           . "WHERE ID_MEMBER = '". $uid ."'";

    $this->_db->Query($query, __FILE__, __LINE__);
  }

  function Delete($username)
  {
    // get database key for this user
    if ( ! $this->_Load($username) )
    {
      return;
    }

    $uid = $this->user['ID_MEMBER'];

    // ---------------------------------------------------
    // following codes are converted from Subs-Members.php

    // Make these peoples' posts guest posts.
    $query =  "UPDATE {messages} "
           .  "SET ID_MEMBER = 0, posterEmail = '' "
           .    "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "UPDATE {polls} "
           . "SET ID_MEMBER = 0 "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    // Make these peoples' posts guest first posts and last posts.
    $query = "UPDATE {topics} "
           . "SET ID_MEMBER_STARTED = 0 "
           . "WHERE ID_MEMBER_STARTED = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "UPDATE {topics} "
               . "SET ID_MEMBER_UPDATED = 0 "
               . "WHERE ID_MEMBER_UPDATED = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "UPDATE {log_actions} "
           . "SET ID_MEMBER = 0 "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "UPDATE {log_banned} "
           . "SET ID_MEMBER = 0 "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "UPDATE {log_errors} "
           . "SET ID_MEMBER = 0 "
           . "WHERE ID_MEMBER = '$uid'";

    // Delete the logs...
    $query = "DELETE FROM {log_boards} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_karma} "
           . "WHERE ID_TARGET = '$uid' OR ID_EXECUTOR = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_mark_read} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_notify} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_online} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_polls} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {log_topics} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {collapsed_categories} "
           . "WHERE ID_MEMBER = '$uid'";

    // It's over, no more moderation for you.
    $query = "DELETE FROM {moderators} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    // If you don't exist we can't ban you.
    $query = "DELETE FROM {ban_items} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    // Remove individual theme settings.
    $query = "DELETE FROM {themes} "
           . "WHERE ID_MEMBER = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    // These users are nobody's buddy nomore.
    $query = "SELECT ID_MEMBER, pm_ignore_list, buddy_list "
           . "FROM {members} "
           . "WHERE FIND_IN_SET('$uid', pm_ignore_list) OR FIND_IN_SET('$uid', buddy_list)";

    $this->_db->Query($query, __FILE__, __LINE__);

    while ( $row = $this->_db->FetchRow() )
    {
      $query = "UPDATE {members} "
             . "SET "
             . " pm_ignore_list = '". implode(',', array_diff(explode(',', $row[1]), array($uid))) ."', "
             . " buddy_list = '". implode(',', array_diff(explode(',', $row[0]), array($uid))) ."' "
             . "WHERE ID_MEMBER = $row[0] LIMIT 1";

      $this->_db->Query($query, __FILE__, __LINE__);
    }

    // end of codes, converted from Subs-Members.php
    // ---------------------------------------------------

    // update the personal message stuff

    // Calculate the number of messages to be deducted from 
    // the field "instanceMessages" of existing users
    $query = "SELECT t2.ID_MEMBER, COUNT(t2.ID_MEMBER) AS delcount "
           . "FROM smf_personal_messages AS t1, smf_pm_recipients AS t2 "
           . "WHERE t1.ID_MEMBER_FROM = '$uid' "
           . "   AND t2.ID_PM = t1.ID_PM "
           . "   AND t2.deleted = 0 "
           . "GROUP BY t2.ID_MEMBER";
    
    $this->_db->Query($query, __FILE__, __LINE__);

    while ( $row = $this->_db->FetchArray() )
    {
      $query = "UPDATE {members} "
             . "SET instantMessages = instanceMessages - ". $row['delcount'] ." "
             . "WHERE instanceMessages > 0 AND "
             . "  ID_MEMBER = ". $row['ID_MEMBER'];

      $this->_db_Query($query, __FILE__, __LINE__);
    }

    $query = "SELECT t2.ID_MEMBER, COUNT(t2.ID_MEMBER) AS readcount "
           . "FROM smf_personal_messages AS t1, smf_pm_recipients AS t2 "
           . "WHERE t1.ID_MEMBER_FROM = '$uid' "
           . "     AND t2.ID_PM = t1.ID_PM "
           . "     AND t2.deleted = 0 "
           . "     AND t2.is_read = 0 "
           . "GROUP BY t2.ID_MEMBER";

    $this->_db->Query($query, __FILE__, __LINE__);

    while ( $row = $this->_db->FetchArray() )
    {
      $query = "UPDATE {members} "
             . "SET instantMessages = unreadMessages - ". $row['readcount'] ." "
             . "WHERE unreadMessages > 0 AND "
             . "  ID_MEMBER = ". $row['ID_MEMBER'];

      $this->_db_Query($query, __FILE__, __LINE__);
    }

        // Do the actual deletion.
    $query = "DELETE FROM {pm_recipients} "
           . "WHERE ID_PM IN (SELECT ID_PM "
           . "                      FROM smf_personal_messages "
           . "                      WHERE ID_MEMBER_FROM = '$uid')";

    $this->_db->Query($query, __FILE__, __LINE__);

    $query = "DELETE FROM {personal_messages} "
           . "WHERE ID_MEMBER_FROM = '$uid'";

    $this->_db->Query($query, __FILE__, __LINE__);

    // Finally, delete member itself
    $query = "DELETE FROM {members} "
           . "WHERE ID_MEMBER = '$uid' "
           . "LIMIT 1";

    $this->_db->Query($query, __FILE__, __LINE__);
  }

  // -------------------------

  function _LogAction($action = NULL)
  {
    if ( $this->_db->connection == false || ! $this->user )
    {
      return false;
    }

    $query = "DELETE FROM {log_online} "
           . "WHERE "
           .   "logTime < NOW() - INTERVAL ". $this->settings['lastActive'] ." SECOND "
           .   "OR ID_MEMBER = '". $this->user['ID_MEMBER'] ."' "
           .   "OR session = '" . @session_id() . "'";

    $this->_db->Query($query, __FILE__, __LINE__);

    if ($action == NULL)
    {
      return;
    }

    $serialized = $_GET;
    $serialized['action']     = $action;
    $serialized['USER_AGENT'] = $_SERVER['HTTP_USER_AGENT'];

    unset($serialized['sesc']);

    $serialized = addslashes(serialize($serialized));

    $query = "INSERT IGNORE INTO {log_online} (session, ID_MEMBER, ip, url) "
           . "VALUES ("
           .   "'". @session_id() . "', "
           .   "'". $this->user['ID_MEMBER'] ."', "
           .   "IFNULL(INET_ATON('". $_SERVER[REMOTE_ADDR] ."'), 0), "
           .   "'$serialized'"
           . ")";

    $this->_db->Query($query, __FILE__, __LINE__);
  }

  // -------------------------

  function _Load($username)
  {
    if ( $this->_db->connection == false )
    {
      embient_error("SMF Database is not connected", __FILE__, __LINE__);
      return false;
    }

    // clear current information
    $this->user = array();

    $query ="SELECT * FROM {members} WHERE memberName = '$username' LIMIT 1";

    if ( ! $this->_db->Query($query, __FILE__, __LINE__) )
    {
      return false;
    }

    if ( $this->_db->GetRowsCount() <= 0 )
    {
      embient_error("User [$username] could not be found in SMF database.", __FILE__, __LINE__);
      return false;
    }

    // fetch info
    $this->user = $this->_db->FetchArray();

    // make it SQL-safe
    foreach ($this->user as $key => $val)
    {
      $this->user[$key] = $val;
    }

    return true;
  }

  function _ConvertUserInfo($user, $default = true)
  {

    // -----------------------
    // convert Embient info to SMF info
    parent::_ConvertUserInfo($user, $default);

    // -----------------------
    // Postprocessing

    // convert Embient time zone to SMF timezone
    if ( ! empty($this->user['timeOffset']) )
    {
      $this->user['timeOffset'] = $this->user['timeOffset'] / 3600;
    }

    // loading real name with first and last name first
    if ( ! empty($user['firstname']) || ! empty($user['firstname']) )
    {
      $this->user['realName'] = trim($user['firstname'] .' '. $user['lastname']);
    }

    // -----------------------
    // load default value
    if ( $default )
    {
      // This might be set to "forum default"...
      if (empty($this->user['timeFormat']))
      {
        $this->user['timeFormat'] = $this->settings['time_format'];
      }

      $this->user['realName']        = embient_load_with_default( trim($this->user['realName']), $this->user['memberName'] );
      $this->user['memberIP']        = $_SERVER[REMOTE_ADDR];
      $this->user['hideEmail']       = embient_load_with_default( $this->user['guest_hideContacts'], $this->settings['guest_hideContacts'] );
      $this->user['passwordSalt']    = embient_load_with_default( $this->user['passwordSalt']   , embient_smf_salt() );
      $this->user['posts']           = embient_load_with_default( $this->user['posts']          , "0"                );
      $this->user['dateRegistered']  = embient_load_with_default( $this->user['dateRegistered'] , time()             );
      $this->user['validation_code'] = embient_load_with_default( $this->user['validation_code'], ''                 );
      $this->user['personalText']    = embient_load_with_default( $this->user['personalText']   , ''                 );
      $this->user['pm_email_notify'] = embient_load_with_default( $this->user['pm_email_notify'], 1                  );
      $this->user['ID_THEME']        = embient_load_with_default( $this->user['ID_THEME']       , 0                  );
      $this->user['ID_POST_GROUP']   = embient_load_with_default( $this->user['ID_POST_GROUP']  , 4                  );
    }
  }
}

---