Code Forge

<?php

/**

*

* @package install

* @version $Id$

* @copyright (c) 2006 phpBB Group

* @license http://opensource.org/licenses/gpl-license.php GNU Public License

*

*/

/**

* @ignore

*/

if (!defined('IN_PHPBB'))

{

        exit;

}

/**

* Default avatar width/height

* @ignore

*/

define('DEFAULT_AVATAR_X', 80);

define('DEFAULT_AVATAR_Y', 80);

// Global functions - all functions can be used by convertors

// SIMPLE FUNCTIONS

/**

* Return the preceding value

*/

function dec($var)

{

        return --$var;

}

/**

* Return the next value

*/

function inc($var)

{

        return ++$var;

}

/**

* Return whether the value is positive

*/

function is_positive($n)

{

        return ($n > 0) ? 1 : 0;

}

/**

* Boolean inverse of the value

*/

function not($var)

{

        return ($var) ? 0 : 1;

}

/**

* Convert a textual value to it's equivalent boolean value

*

* @param string $str String to convert (converts yes, on, y, 1 and true to boolean true)

* @return boolean The equivalent value

*/

function str_to_bool($str)

{

        $str = strtolower($str);

        return ($str == 'yes' || $str == 'on' || $str == 'y' || $str == 'true' || $str == '1') ? true : false;

}

/**

* Function to mimic php's empty() function (it is the same)

*/

function is_empty($mixed)

{

        return empty($mixed);

}

/**

* Convert the name of a user's primary group to the appropriate equivalent phpBB group id

*

* @param string $status The name of the group

* @return int The group_id corresponding to the equivalent group

*/

function str_to_primary_group($status)

{

        switch (ucfirst(strtolower($status)))

        {

                case 'Administrator':

                        return get_group_id('administrators');

                break;

                case 'Super moderator':

                case 'Global moderator':

                case 'Moderator':

                        return get_group_id('global_moderators');

                break;

                case 'Guest':

                case 'Anonymous':

                        return get_group_id('guests');

                break;

                default:

                        return get_group_id('registered');

                break;

        }

}

/**

* Convert a boolean into the appropriate phpBB constant indicating whether the item is locked

*/

function is_item_locked($bool)

{

        return ($bool) ? ITEM_LOCKED : ITEM_UNLOCKED;

}

/**

* Convert a value from days to seconds

*/

function days_to_seconds($days)

{

        return ($days * 86400);

}

/**

* Determine whether a user is anonymous and return the appropriate new user_id

*/

function is_user_anonymous($user_id)

{

        return ($user_id > ANONYMOUS) ? $user_id : ANONYMOUS;

}

/**

* Generate a key value based on existing values

*

* @param int $pad Amount to add to the maximum value

* @return int Key value

*/

function auto_id($pad = 0)

{

        global $auto_id, $convert_row;

        if (!empty($convert_row['max_id']))

        {

                return $convert_row['max_id'] + $pad;

        }

        return $auto_id + $pad;

}

/**

* Convert a boolean into the appropriate phpBB constant indicating whether the user is active

*/

function set_user_type($user_active)

{

        return ($user_active) ? USER_NORMAL : USER_INACTIVE;

}

/**

* Convert a value from minutes to hours

*/

function minutes_to_hours($minutes)

{

        return ($minutes / 3600);

}

/**

* Return the group_id for a given group name

*/

function get_group_id($group_name)

{

        global $db, $group_mapping;

        if (empty($group_mapping))

        {

                $sql = 'SELECT group_name, group_id

                        FROM ' . GROUPS_TABLE;

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

                $group_mapping = array();

                while ($row = $db->sql_fetchrow($result))

                {

                        $group_mapping[strtoupper($row['group_name'])] = (int) $row['group_id'];

                }

                $db->sql_freeresult($result);

        }

        if (!sizeof($group_mapping))

        {

                add_default_groups();

                return get_group_id($group_name);

        }

        if (isset($group_mapping[strtoupper($group_name)]))

        {

                return $group_mapping[strtoupper($group_name)];

        }

        return $group_mapping['REGISTERED'];

}

/**

* Generate the email hash stored in the users table

*

* Note: Deprecated, calls should directly go to phpbb_email_hash()

*/

function gen_email_hash($email)

{

        return phpbb_email_hash($email);

}

/**

* Convert a boolean into the appropriate phpBB constant indicating whether the topic is locked

*/

function is_topic_locked($bool)

{

        return (!empty($bool)) ? ITEM_LOCKED : ITEM_UNLOCKED;

}

/**

* Generate a bbcode_uid value

*/

function make_uid($timestamp)

{

        static $last_timestamp, $last_uid;

        if (empty($last_timestamp) || $timestamp != $last_timestamp)

        {

                $last_uid = substr(base_convert(unique_id(), 16, 36), 0, BBCODE_UID_LEN);

        }

        $last_timestamp = $timestamp;

        return $last_uid;

}

/**

* Validate a website address

*/

function validate_website($url)

{

        if ($url === 'http://')

        {

                return '';

        }

        else if (!preg_match('#^[a-z0-9]+://#i', $url) && strlen($url) > 0)

        {

                return 'http://' . $url;

        }

        return $url;

}

/**

* Convert nulls to zeros for fields which allowed a NULL value in the source but not the destination

*/

function null_to_zero($value)

{

        return ($value === NULL) ? 0 : $value;

}

/**

* Convert nulls to empty strings for fields which allowed a NULL value in the source but not the destination

*/

function null_to_str($value)

{

        return ($value === NULL) ? '' : $value;

}

// EXTENDED FUNCTIONS

/**

* Get old config value

*/

function get_config_value($config_name)

{

        static $convert_config;

        if (!isset($convert_config))

        {

                $convert_config = get_config();

        }

        if (!isset($convert_config[$config_name]))

        {

                return false;

        }

        return (empty($convert_config[$config_name])) ? '' : $convert_config[$config_name];

}

/**

* Convert an IP address from the hexadecimal notation to normal dotted-quad notation

*/

function decode_ip($int_ip)

{

        if (!$int_ip)

        {

                return $int_ip;

        }

        $hexipbang = explode('.', chunk_split($int_ip, 2, '.'));

        // Any mod changing the way ips are stored? Then we are not able to convert and enter the ip "as is" to not "destroy" anything...

        if (sizeof($hexipbang) < 4)

        {

                return $int_ip;

        }

        return hexdec($hexipbang[0]) . '.' . hexdec($hexipbang[1]) . '.' . hexdec($hexipbang[2]) . '.' . hexdec($hexipbang[3]);

}

/**

* Reverse the encoding of wild-carded bans

*/

function decode_ban_ip($int_ip)

{

        return str_replace('255', '*', decode_ip($int_ip));

}

/**

* Determine the MIME-type of a specified filename

* This does not actually inspect the file, but simply uses the file extension

*/

function mimetype($filename)

{

        if (!preg_match('/\.([a-z0-9]+)$/i', $filename, $m))

        {

                return 'application/octet-stream';

        }

        switch (strtolower($m[1]))

        {

                case 'zip':                return 'application/zip';

                case 'jpeg':        return 'image/jpeg';

                case 'jpg':                return 'image/jpeg';

                case 'jpe':                return 'image/jpeg';

                case 'png':                return 'image/png';

                case 'gif':                return 'image/gif';

                case 'htm':

                case 'html':        return 'text/html';

                case 'tif':                return 'image/tiff';

                case 'tiff':        return 'image/tiff';

                case 'ras':                return 'image/x-cmu-raster';

                case 'pnm':                return 'image/x-portable-anymap';

                case 'pbm':                return 'image/x-portable-bitmap';

                case 'pgm':                return 'image/x-portable-graymap';

                case 'ppm':                return 'image/x-portable-pixmap';

                case 'rgb':                return 'image/x-rgb';

                case 'xbm':                return 'image/x-xbitmap';

                case 'xpm':                return 'image/x-xpixmap';

                case 'xwd':                return 'image/x-xwindowdump';

                case 'z':                return 'application/x-compress';

                case 'gtar':        return 'application/x-gtar';

                case 'tgz':                return 'application/x-gtar';

                case 'gz':                return 'application/x-gzip';

                case 'tar':                return 'application/x-tar';

                case 'xls':                return 'application/excel';

                case 'pdf':                return 'application/pdf';

                case 'ppt':                return 'application/powerpoint';

                case 'rm':                return 'application/vnd.rn-realmedia';

                case 'wma':                return 'audio/x-ms-wma';

                case 'swf':                return 'application/x-shockwave-flash';

                case 'ief':                return 'image/ief';

                case 'doc':

                case 'dot':

                case 'wrd':                return 'application/msword';

                case 'ai':

                case 'eps':

                case 'ps':                return 'application/postscript';

                case 'asc':

                case 'txt':

                case 'c':

                case 'cc':

                case 'h':

                case 'hh':

                case 'cpp':

                case 'hpp':

                case 'php':

                case 'php3':        return 'text/plain';

                default:                 return 'application/octet-stream';

        }

}

/**

* Obtain the dimensions of all remotely hosted avatars

* This should only be called from execute_last

* There can be significant network overhead if there are a large number of remote avatars

* @todo Look at the option of allowing the user to decide whether this is called or to force the dimensions

*/

function remote_avatar_dims()

{

        global $db;

        $sql = 'SELECT user_id, user_avatar

                FROM ' . USERS_TABLE . '

                WHERE user_avatar_type = ' . AVATAR_REMOTE;

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

        $remote_avatars = array();

        while ($row = $db->sql_fetchrow($result))

        {

                $remote_avatars[(int) $row['user_id']] = $row['user_avatar'];

        }

        $db->sql_freeresult($result);

        foreach ($remote_avatars as $user_id => $avatar)

        {

                $width = (int) get_remote_avatar_dim($avatar, 0);

                $height = (int) get_remote_avatar_dim($avatar, 1);

                $sql = 'UPDATE ' . USERS_TABLE . '

                        SET user_avatar_width = ' . (int) $width . ', user_avatar_height = ' . (int) $height . '

                        WHERE user_id = ' . $user_id;

                $db->sql_query($sql);

        }

}

function import_avatar_gallery($gallery_name = '', $subdirs_as_galleries = false)

{

        global $config, $convert, $phpbb_root_path, $user;

        $relative_path = empty($convert->convertor['source_path_absolute']);

        // check for trailing slash

        if (rtrim($convert->convertor['avatar_gallery_path'], '/') === '')

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_GALLERY_PATH'], 'import_avatar_gallery()'), __LINE__, __FILE__);

        }

        $src_path = relative_base(path($convert->convertor['avatar_gallery_path'], $relative_path), $relative_path);

        if (is_dir($src_path))

        {

                // Do not die on failure... safe mode restrictions may be in effect.

                copy_dir($convert->convertor['avatar_gallery_path'], path($config['avatar_gallery_path']) . $gallery_name, !$subdirs_as_galleries, false, false, $relative_path);

                // only doing 1 level deep. (ibf 1.x)

                // notes: ibf has 2 tiers: directly in the avatar directory for base gallery (handled in the above statement), plus subdirs(handled below).

                // recursive subdirs ignored. -- i don't know if other forums support recursive galleries. if they do, this following code could be upgraded to be recursive.

                if ($subdirs_as_galleries)

                {

                        $dirlist = array();

                        if ($handle = @opendir($src_path))

                        {

                                while ($entry = readdir($handle))

                                {

                                        if ($entry[0] == '.' || $entry == 'CVS' || $entry == 'index.htm')

                                        {

                                                continue;

                                        }

                                        if (is_dir($src_path . $entry))

                                        {

                                                $dirlist[] = $entry;

                                        }

                                }

                                closedir($handle);

                        }

                        else if ($dir = @dir($src_path))

                        {

                                while ($entry = $dir->read())

                                {

                                        if ($entry[0] == '.' || $entry == 'CVS' || $entry == 'index.htm')

                                        {

                                                continue;

                                        }

                                        if (is_dir($src_path . $entry))

                                        {

                                                $dirlist[] = $entry;

                                        }

                                }

                                $dir->close();

                        }

                        for ($i = 0; $i < sizeof($dirlist); ++$i)

                        {

                                $dir = $dirlist[$i];

                                // Do not die on failure... safe mode restrictions may be in effect.

                                copy_dir(path($convert->convertor['avatar_gallery_path'], $relative_path) . $dir, path($config['avatar_gallery_path']) . $dir, true, false, false, $relative_path);

                        }

                }

        }

}

function import_attachment_files($category_name = '')

{

        global $config, $convert, $phpbb_root_path, $db, $user;

        $sql = 'SELECT config_value AS upload_path

                FROM ' . CONFIG_TABLE . "

                WHERE config_name = 'upload_path'";

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

        $config['upload_path'] = $db->sql_fetchfield('upload_path');

        $db->sql_freeresult($result);

        $relative_path = empty($convert->convertor['source_path_absolute']);

        if (empty($convert->convertor['upload_path']))

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_UPLOAD_DIR'], 'import_attachment_files()'), __LINE__, __FILE__);

        }

        if (is_dir(relative_base(path($convert->convertor['upload_path'], $relative_path), $relative_path)))

        {

                copy_dir($convert->convertor['upload_path'], path($config['upload_path']) . $category_name, true, false, true, $relative_path);

        }

}

function attachment_forum_perms($forum_id)

{

        if (!is_array($forum_id))

        {

                $forum_id = array($forum_id);

        }

        return serialize($forum_id);

}

// base64todec function

// -> from php manual?

function base64_unpack($string)

{

        $chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ+-';

        $base = strlen($chars);

        $length = strlen($string);

        $number = 0;

        for ($i = 1; $i <= $length; $i++)

        {

                $pos = $length - $i;

                $operand = strpos($chars, substr($string, $pos, 1));

                $exponent = pow($base, $i-1);

                $dec_value = $operand * $exponent;

                $number += $dec_value;

        }

        return $number;

}

function _import_check($config_var, $source, $use_target)

{

        global $convert, $config;

        $result = array(

                'orig_source'        => $source,

                'copied'                => false,

                'relative_path'        => (empty($convert->convertor['source_path_absolute'])) ? true : false,

        );

        // copy file will prepend $phpBB_root_path

        $target = $config[$config_var] . '/' . utf8_basename(($use_target === false) ? $source : $use_target);

        if (!empty($convert->convertor[$config_var]) && strpos($source, $convert->convertor[$config_var]) !== 0)

        {

                $source = $convert->convertor[$config_var] . $source;

        }

        $result['source'] = $source;

        if (file_exists(relative_base($source, $result['relative_path'], __LINE__, __FILE__)))

        {

                $result['copied'] = copy_file($source, $target, false, false, $result['relative_path']);

        }

        if ($result['copied'])

        {

                $result['target'] = utf8_basename($target);

        }

        else

        {

                $result['target'] = ($use_target !== false) ? $result['orig_source'] : utf8_basename($target);

        }

        return $result;

}

function import_attachment($source, $use_target = false)

{

        if (empty($source))

        {

                return '';

        }

        global $convert, $phpbb_root_path, $config, $user;

        // check for trailing slash

        if (rtrim($convert->convertor['upload_path'], '/') === '')

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_UPLOAD_DIR'], 'import_attachment()'), __LINE__, __FILE__);

        }

        $result = _import_check('upload_path', $source, $use_target);

        if ($result['copied'])

        {

                // Thumbnails?

                if (is_array($convert->convertor['thumbnails']))

                {

                        $thumb_dir = $convert->convertor['thumbnails'][0];

                        $thumb_prefix = $convert->convertor['thumbnails'][1];

                        $thumb_source = $thumb_dir . $thumb_prefix . utf8_basename($result['source']);

                        if (strpos($thumb_source, $convert->convertor['upload_path']) !== 0)

                        {

                                $thumb_source = $convert->convertor['upload_path'] . $thumb_source;

                        }

                        $thumb_target = $config['upload_path'] . '/thumb_' . $result['target'];

                        if (file_exists(relative_base($thumb_source, $result['relative_path'], __LINE__, __FILE__)))

                        {

                                copy_file($thumb_source, $thumb_target, false, false, $result['relative_path']);

                        }

                }

        }

        return $result['target'];

}

function import_rank($source, $use_target = false)

{

        if (empty($source))

        {

                return '';

        }

        global $convert, $phpbb_root_path, $config, $user;

        if (!isset($convert->convertor['ranks_path']))

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_RANKS_PATH'], 'import_rank()'), __LINE__, __FILE__);

        }

        $result = _import_check('ranks_path', $source, $use_target);

        return $result['target'];

}

function import_smiley($source, $use_target = false)

{

        if (empty($source))

        {

                return '';

        }

        global $convert, $phpbb_root_path, $config, $user;

        // check for trailing slash

        if (rtrim($convert->convertor['smilies_path'], '/') === '')

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_SMILIES_PATH'], 'import_smiley()'), __LINE__, __FILE__);

        }

        $result = _import_check('smilies_path', $source, $use_target);

        return $result['target'];

}

/*

*/

function import_avatar($source, $use_target = false, $user_id = false)

{

        if (empty($source) || preg_match('#^https?:#i', $source) || preg_match('#blank\.(gif|png)$#i', $source))

        {

                return;

        }

        global $convert, $phpbb_root_path, $config, $user;

        // check for trailing slash

        if (rtrim($convert->convertor['avatar_path'], '/') === '')

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_AVATAR_PATH'], 'import_avatar()'), __LINE__, __FILE__);

        }

        if ($use_target === false && $user_id !== false)

        {

                $use_target = $config['avatar_salt'] . '_' . $user_id . '.' . substr(strrchr($source, '.'), 1);

        }

        $result = _import_check('avatar_path', $source, $use_target);

        return ((!empty($user_id)) ? $user_id : $use_target) . '.' . substr(strrchr($source, '.'), 1);

}

/**

* @todo all image dimension functions below (there are a *lot*) should get revisited and converted to one or two functions (no more needed, really).

*/

/**

* Calculate the size of the specified image

* Called from the following functions for calculating the size of specific image types

*/

function get_image_dim($source)

{

        if (empty($source))

        {

                return array(0, 0);

        }

        global $convert;

        $relative_path = empty($convert->convertor['source_path_absolute']);

        if (file_exists(relative_base($source, $relative_path)))

        {

                $image = relative_base($source, $relative_path);

                return @getimagesize($image);

        }

        return false;

}

/**

* Obtain the width of the specified smilie

*/

function get_smiley_width($src)

{

        return get_smiley_dim($src, 0);

}

/**

* Obtain the height of the specified smilie

*/

function get_smiley_height($src)

{

        return get_smiley_dim($src, 1);

}

/**

* Obtain the size of the specified smilie (using the cache if possible) and cache the value

*/

function get_smiley_dim($source, $axis)

{

        if (empty($source))

        {

                return 15;

        }

        static $smiley_cache = array();

        if (isset($smiley_cache[$source]))

        {

                return $smiley_cache[$source][$axis];

        }

        global $convert, $phpbb_root_path, $config, $user;

        $orig_source = $source;

        if (!isset($convert->convertor['smilies_path']))

        {

                $convert->p_master->error(sprintf($user->lang['CONV_ERROR_NO_SMILIES_PATH'], 'get_smiley_dim()'), __LINE__, __FILE__);