+ <!-- EVENT acp_forums_normal_settings_append -->

+ <!-- EVENT acp_main_notice_after -->

+

+

+ <!-- EVENT acp_main_actions_append -->

+<!-- EVENT acp_users_overview_options_append -->

+var imgTemplates = {

+ upDisabled: $('.template-up-img-disabled'),

+ downDisabled: $('.template-down-img-disabled')

+phpbb.addAjaxCallback('row_down', function() {

+ trSwap = tr.next();

+ if (tr.is(':first-child')) {

+ var upImg = imgTemplates.up.clone().attr('href', tr.attr('data-up'));

+ tr.find('.up').html(upImg);

+ trSwap.find('.up').html(imgTemplates.upDisabled.clone());

+ tr.insertAfter(trSwap);

+ if (tr.is(':last-child')) {

+ tr.find('.down').html(imgTemplates.downDisabled.clone());

+ var downImg = imgTemplates.down.clone().attr('href', trSwap.attr('data-down'));

+ trSwap.find('.down').html(downImg);

+ selector: trSwap.find('.down').children('a'),

+phpbb.addAjaxCallback('row_up', function() {

+ trSwap = tr.prev();

+ if (tr.is(':last-child')) {

+ var downImg = imgTemplates.down.clone().attr('href', tr.attr('data-down'));

+ tr.find('.down').html(downImg);

+ trSwap.find('.down').html(imgTemplates.downDisabled.clone());

+ tr.insertBefore(trSwap);

+ if (tr.is(':first-child')) {

+ tr.find('.up').html(imgTemplates.upDisabled.clone());

+ var upImg = imgTemplates.up.clone().attr('href', trSwap.attr('data-up'));

+ trSwap.find('.up').html(upImg);

+ selector: trSwap.find('.up').children('a'),

+phpbb.addAjaxCallback('activate_deactivate', function(res) {

+ newHref = el.attr('href');

+ if (newHref.indexOf('deactivate') !== -1) {

+ newHref = newHref.replace('deactivate', 'activate')

+ } else {

+ newHref = newHref.replace('activate', 'deactivate')

+ el.attr('href', newHref);

+phpbb.addAjaxCallback('row_delete', function() {

+ if (ajax !== 'false') {

+<link href="{T_TEMPLATE_PATH}/admin.css" rel="stylesheet" type="text/css" media="screen" />

+

+

+<link href="{T_TEMPLATE_PATH}/admin.css" rel="stylesheet" type="text/css" media="screen" />

+<!-- EVENT acp_overall_footer_after -->

+

+<!-- EVENT acp_overall_header_head_append -->

+<!-- EVENT acp_simple_footer_after -->

+<!-- EVENT acp_simple_header_head_append -->

+ phpbb.timezoneSwitchDate(false);

+ phpbb.timezoneEnableDateSelection

+phpbb.alertTime = 100;

+var loadingAlert = $('#loadingalert');

+var phpbbAlertTimer = null;

+ * Display a loading screen

+ * @returns object Returns loadingAlert.

+phpbb.loadingAlert = function() {

+ if (dark.is(':visible')) {

+ loadingAlert.fadeIn(phpbb.alertTime);

+ } else {

+ loadingAlert.show();

+ dark.fadeIn(phpbb.alertTime, function() {

+ phpbbAlertTimer = setTimeout(function() {

+ if (loadingAlert.is(':visible')) {

+ return loadingAlert;

+};

+

+/**

+ * Clear loading alert timeout

+*/

+phpbb.clearLoadingTimeout = function() {

+ if (phpbbAlertTimer !== null) {

+ clearTimeout(phpbbAlertTimer);

+ phpbbAlertTimer = null;

+ }

+};

+ fade.fadeOut(phpbb.alertTime, function() {

+ if (loadingAlert.is(':visible')) {

+ loadingAlert.fadeOut(phpbb.alertTime, function() {

+ div.fadeIn(phpbb.alertTime);

+ } else if (dark.is(':visible')) {

+ div.fadeIn(phpbb.alertTime);

+ } else {

+ dark.fadeIn(phpbb.alertTime);

+};

+ var clickHandler = function(e) {

+ fade.fadeOut(phpbb.alertTime, function() {

+ div.find('input[type="button"]').unbind('click', clickHandler);

+ div.find('input[type="button"]').one('click', clickHandler);

+ dark.fadeOut(phpbb.alertTime, function() {

+ fade.fadeOut(phpbb.alertTime, function() {

+ if (loadingAlert.is(':visible')) {

+ loadingAlert.fadeOut(phpbb.alertTime, function() {

+ div.fadeIn(phpbb.alertTime);

+ } else if (dark.is(':visible')) {

+ div.fadeIn(phpbb.alertTime);

+ } else {

+ dark.fadeIn(phpbb.alertTime);

+};

+phpbb.parseQuerystring = function(string) {

+ for (i = 0; i < string.length; i++) {

+};

+ isForm = elements.is('form'),

+ eventName = isForm ? 'submit' : 'click';

+ elements.bind(eventName, function(event) {

+ if ($this.find('input[type="submit"][data-clicked]').attr('data-ajax') === 'false') {

+ function returnHandler(res) {

+ phpbb.clearLoadingTimeout();

+

+ if (typeof res.S_CONFIRM_ACTION === 'undefined') {

+ if (typeof res.MESSAGE_TITLE !== 'undefined') {

+ } else {

+ dark.fadeOut(phpbb.alertTime);

+ if (typeof phpbb.ajaxCallbacks[callback] === 'function') {

+ phpbb.ajaxCallbacks[callback].call(that, res);

+ if (res.REFRESH_DATA) {

+ if (typeof refresh === 'function') {

+ } else if (typeof refresh !== 'boolean') {

+ if (refresh) {

+ dark.fadeOut(phpbb.alertTime, function() {

+ } else {

+ if (del) {

+ phpbb.loadingAlert();

+ success: returnHandler,

+ error: errorHandler

+ function errorHandler() {

+ phpbb.clearLoadingTimeout();

+ var runFilter = (typeof options.filter === 'function');

+ if (isForm) {

+ if ($this.find('input[type="submit"][data-clicked]')) {

+ } else {

+ if (runFilter && !options.filter.call(this, data)) {

+ phpbb.loadingAlert();

+ success: returnHandler,

+ error: errorHandler

+ if (isForm) {

+};

+* @param bool keepSelection Shall we keep the value selected, or shall the user be forced to repick one.

+phpbb.timezoneSwitchDate = function(keepSelection) {

+ keepSelection = true;

+ if (typeof keepSelection !== 'undefined' && !keepSelection) {

+ var timezoneOptions = $('#timezone > optgroup option');

+ if (timezoneOptions.filter(':selected').length <= 0) {

+ timezoneOptions.filter(':first').attr('selected', true);

+ }

+};

+phpbb.timezoneEnableDateSelection = function() {

+};

+* @param bool forceSelector Shall we select the suggestion?

+phpbb.timezonePreselectSelect = function(forceSelector) {

+ var prefixLength = prefix.length;

+ var selectorOptions = $('#tz_date > option');

+ for (var i = 0; i < selectorOptions.length; ++i) {

+ var option = selectorOptions[i];

+ if (option.value.substring(0, prefixLength) == prefix) {

+ if ($('#tz_date').val() != option.value && !forceSelector) {

+ phpbb.timezoneSwitchDate(true);

+ phpbb.timezoneSwitchDate(!forceSelector);

+};

+// Toggle notification list

+$('#notification_list_button').click(function(e) {

+ $('#notification_list').toggle();

+ e.preventDefault();

+});

+$('#phpbb').click(function(e) {

+ var target = e.target;

+

+ if (!$(target).is('#notification_list') && !$(target).is('#notification_list_button') && !$(target).parents().is('#notification_list')) {

+ $('#notification_list').hide();

+ }

+});

+

+phpbb.ajaxCallbacks = {};

+phpbb.addAjaxCallback = function(id, callback) {

+ if (typeof callback === 'function') {

+ phpbb.ajaxCallbacks[id] = callback;

+};

+phpbb.addAjaxCallback('alt_text', function() {

+ altText;

+ altText = el.attr('data-alt-text');

+ el.attr('title', altText);

+ el.text(altText);

+phpbb.addAjaxCallback('toggle_link', function() {

+ toggleText,

+ toggleUrl,

+ toggleClass;

+ toggleText = el.attr('data-toggle-text');

+ el.attr('title', toggleText);

+ el.text(toggleText);

+ toggleUrl = el.attr('data-toggle-url');

+ el.attr('href', toggleUrl);

+ toggleClass = el.attr('data-toggle-class');

+ el.parent().attr('class', toggleClass);

+// In case $phpbb_adm_relative_path is not set (in case of an update), use the default.

+$phpbb_adm_relative_path = (isset($phpbb_adm_relative_path)) ? $phpbb_adm_relative_path : 'adm/';

+$phpbb_admin_path = (defined('PHPBB_ADMIN_PATH')) ? PHPBB_ADMIN_PATH : $phpbb_root_path . $phpbb_adm_relative_path;

+

+$phpbb_container = phpbb_create_default_container($phpbb_root_path, $phpEx);

+$phpbb_hook_finder = $phpbb_container->get('hook_finder');

+foreach ($phpbb_hook_finder->find() as $hook)

+ - @config

+ - @dbal.conn

+ - %core.root_path%

+ - %core.php_ext%

+ hook_finder:

+ class: phpbb_hook_finder

+ arguments:

+ - %core.root_path%

+ - .%core.php_ext%

+ - @cache.driver

+

+ 'report_id' => array('UINT', NULL, 'auto_increment'),

+ 'reason_id' => array('USINT', 0),

+ 'post_id' => array('UINT', 0),

+ 'pm_id' => array('UINT', 0),

+ 'user_id' => array('UINT', 0),

+ 'user_notify' => array('BOOL', 0),

+ 'report_closed' => array('BOOL', 0),

+ 'report_time' => array('TIMESTAMP', 0),

+ 'report_text' => array('MTEXT_UNI', ''),

+ 'reported_post_text' => array('MTEXT_UNI', ''),

+ 'reported_post_uid' => array('VCHAR:8', ''),

+ 'reported_post_bitfield' => array('VCHAR:255', ''),

+ 'reported_post_enable_magic_url' => array('BOOL', 1),

+ 'reported_post_enable_smilies' => array('BOOL', 1),

+ 'reported_post_enable_bbcode' => array('BOOL', 1)

+ <li><a href="#template-events">Template Events</a></li>

+ <a name="template-events"></a><h3>4.iii. Template Events</h3>

+ <p>Template events must follow this format: <code>&lt;!-- EVENT event_name --&gt;</code></p>

+ <p>Using the above example, files named <code>event_name.html</code> located within extensions will be injected into the location of the event.</p>

+

+ <h4>Template event naming guidelines:</h4>

+ <ul>

+ <li>An event name must be all lowercase, with each word separated by an underscore.</li>

+ <li>An event name must briefly describe the location and purpose of the event.</li>

+ <li>An event name must end with one of the following suffixes:</li>

+ <ul>

+ <li><code>_prepend</code> - This event adds an item to the beginning of a block of related items, or adds to the beginning of individual items in a block.</li>

+ <li><code>_append</code> - This event adds an item to the end of a block of related items, or adds to the end of individual items in a block.</li>

+ <li><code>_before</code> - This event adds content directly before the specified block</li>

+ <li><code>_after</code> - This event adds content directly after the specified block</li>

+ </ul>

+ </ul>

+

+ <h4>Template event documentation</h4>

+ <p>Events must be documented in <code>phpBB/docs/events.md</code> in alphabetical order based on the event name. The format is as follows:</p>

+

+ <ul><li>An event found in only one template file:

+ <div class="codebox"><pre>event_name

+===

+* Location: styles/&lt;style_name&gt;/template/filename.html

+* Purpose: A brief description of what this event should be used for.

+This may span multiple lines.

+</pre></div></li>

+ <li>An event found in multiple template files:

+ <div class="codebox"><pre>event_name

+===

+* Locations:

+ + first/file/path.html

+ + second/file/path.html

+* Purpose: Same as above.

+</pre></div>

+ <li>An event that is found multiple times in a file should have the number of instances in parenthesis next to the filename.

+ <div class="codebox"><pre>event_name

+===

+* Locations:

+ + first/file/path.html (2)

+ + second/file/path.html

+* Purpose: Same as above.

+</pre></div></li>

+ <li>An actual example event documentation:

+ <div class="codebox"><pre>forumlist_body_last_post_title_prepend

+====

+* Locations:

+ + styles/prosilver/template/forumlist_body.html

+ + styles/subsilver2/template/forumlist_body.html

+* Purpose: Add content before the post title of the latest post in a forum on the forum list.</pre></div></ul><br />

+

+acp_forums_normal_settings_append

+===

+* Location: adm/style/acp_forums.html

+* Purpose: Add settings to forums

+

+acp_main_actions_append

+===

+* Location: adm/style/acp_main.html

+* Purpose: Add actions to the ACP main page below the cache purge action

+

+acp_main_notice_after

+===

+* Location: adm/style/acp_main.html

+* Purpose: Add notices or other blocks in the ACP below other configuration notices

+

+acp_overall_footer_after

+===

+* Location: adm/style/overall_footer.html

+* Purpose: Add content below the footer in the ACP

+

+acp_overall_header_head_append

+===

+* Location: adm/style/overall_header.html

+* Add assets within the `<head>` tags in the ACP

+

+acp_simple_footer_after

+===

+* Location: adm/style/simple_footer.html

+* Purpose: Add content below the simple footer in the ACP

+

+acp_simple_header_head_append

+===

+* Location: adm/style/overall_header.html

+* Add assets within the `<head>` tags in the simple header of the ACP

+

+acp_users_overview_options_append

+===

+* Location: adm/style/acp_users.html

+* Purpose: Add options and settings on user overview page

+

+forumlist_body_last_post_title_prepend

+====

+* Locations:

+ + styles/prosilver/template/forumlist_body.html

+ + styles/subsilver2/template/forumlist_body.html

+* Purpose: Add content before the post title of the latest post in a forum on the forum list.

+

+index_body_stat_blocks_before

+===

+* Locations:

+ + styles/prosilver/template/index_body.html

+ + styles/subsilver2/template/index_body.html

+* Purpose: Add new statistic blocks above the Who Is Online and Board Statistics blocks

+

+overall_footer_after

+===

+* Locations:

+ + styles/prosilver/template/overall_footer.html

+ + styles/subsilver2/template/overall_footer.html

+* Purpose: Add content at the end of the file, directly prior to the `</body>` tag

+

+overall_footer_breadcrumb_append

+===

+* Location: styles/prosilver/template/overall_footer.html

+* Purpose: Add links to the list of breadcrumbs in the footer

+

+overall_footer_copyright_append

+===

+* Locations:

+ + styles/prosilver/template/overall_footer.html

+ + styles/subsilver2/template/overall_footer.html

+* Purpose: Add content after the copyright line (no new line by default), before the ACP link

+

+overall_footer_copyright_prepend

+===

+* Locations:

+ + styles/prosilver/template/overall_footer.html

+ + styles/subsilver2/template/overall_footer.html

+* Purpose: Add content before the copyright line

+

+overall_header_breadcrumb_append

+===

+* Locations:

+ + styles/prosilver/template/overall_header.html

+ + styles/subsilver2/template/breadcrumbs.html

+* Purpose: Add links to the list of breadcrumbs in the header

+

+overall_header_head_append

+===

+* Locations:

+ + styles/prosilver/template/overall_header.html

+ + styles/subsilver2/template/overall_header.html

+* Purpose: Add asset calls directly before the `</head>` tag

+

+overall_header_navigation_append

+===

+* Location: styles/prosilver/template/overall_header.html

+* Purpose: Add links after the navigation links in the header

+

+overall_header_navigation_prepend

+===

+* Location: styles/prosilver/template/overall_header.html

+* Purpose: Add links before the navigation links in the header

+

+posting_editor_options_prepend

+===

+* Locations:

+ + styles/prosilver/template/posting_editor.html

+ + styles/prosilver/template/posting_body.html

+* Purpose: Add posting options on the posting screen

+

+simple_footer_after

+===

+* Location: styles/prosilver/template/simple_footer.html

+* Purpose: Add content directly prior to the `</body>` tag of the simple footer

+

+ucp_pm_viewmessage_print_head_append

+===

+* Location: styles/prosilver/template/ucp_pm_viewmessage_print.html

+* Purpose: Add asset calls directly before the `</head>` tag of the Print PM screen

+

+viewtopic_print_head_append

+===

+* Location: styles/prosilver/template/viewtopic_print.html

+* Purpose: Add asset calls directly before the `</head>` tag of the Print Topic screen

+

+viewtopic_topic_title_prepend

+===

+* Locations:

+ + styles/prosilver/template/viewtopic_body.html

+ + styles/subsilver2/template/viewtopic_body.html

+* Purpose: Add content directly before the topic title link on the View topic screen

+ sql_query = SELECT

+\

+ p.post_id AS id,

+\

+ p.forum_id,

+\

+ p.topic_id,

+\

+ p.poster_id,

+\

+ CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post,

+\

+ p.post_time,

+\

+ p.post_subject,

+\

+ p.post_subject as title,

+\

+ p.post_text as data,

+\

+ t.topic_last_post_time,

+\

+ 0 as deleted

+\

+ FROM phpbb_posts p, phpbb_topics t

+\

+ WHERE

+\

+ p.topic_id = t.topic_id

+\

+ sql_query = SELECT

+\

+ p.post_id AS id,

+\

+ p.forum_id,

+\

+ p.topic_id,

+\

+ p.poster_id,

+\

+ CASE WHEN p.post_id = t.topic_first_post_id THEN 1 ELSE 0 END as topic_first_post,

+\

+ p.post_time,

+\

+ p.post_subject,

+\

+ p.post_subject as title,

+\

+ p.post_text as data,

+\

+ t.topic_last_post_time,

+\

+ 0 as deleted

+\

+ FROM phpbb_posts p, phpbb_topics t

+\

+ WHERE

+\

+ p.topic_id = t.topic_id

+\

+ $phpbb_container = phpbb_create_default_container($phpbb_root_path, $phpEx);

+ phpbb_cache_moderators($db, $cache, $auth);

+

+ phpbb_cache_moderators($db, $cache, $auth);

+ global $config, $db, $cache, $user, $auth, $template, $request;

+

+

+

+

+

+ phpbb_cache_moderators($db, $cache, $auth);

+

+

+ global $phpbb_container;

+ $phpbb_container->get('cache.driver')->destroy('_modules_' . $p_class);

+ $phpbb_container->get('cache.driver')->destroy('sql', MODULES_TABLE);

+ global $db, $cache, $user, $auth;

+ phpbb_cache_moderators($db, $cache, $auth);

+ phpbb_update_foes($db, $auth, $group_id, $user_id);

+ global $db, $cache, $user, $auth;

+ phpbb_cache_moderators($db, $cache, $auth);

+ phpbb_update_foes($db, $auth, $group_id, $user_id);

+ global $user, $db, $cache, $auth;

+ phpbb_cache_moderators($db, $cache, $auth);

+ $userdata = $auth->obtain_user_data($user_id);

+ global $db, $auth, $cache, $template, $user;

+ phpbb_cache_moderators($db, $cache, $auth);

+

+

+

+ 'RANK_IMAGE' => ($edit_img) ? $phpbb_root_path . $config['ranks_path'] . '/' . $edit_img : htmlspecialchars($phpbb_admin_path) . 'images/spacer.gif',

+

+

+ );

+ global $db, $cache, $auth;

+

+ phpbb_cache_moderators($db, $cache, $auth);

+ * Retrieves data wanted by acl function from the database for the

+ * specified user.

+ *

+ * @param int $user_id User ID

+ * @return array User attributes

+ */

+ public function obtain_user_data($user_id)

+ {

+ global $db;

+

+ $sql = 'SELECT user_id, username, user_permissions, user_type

+ FROM ' . USERS_TABLE . '

+ WHERE user_id = ' . $user_id;

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

+ $user_data = $db->sql_fetchrow($result);

+ $db->sql_freeresult($result);

+ return $user_data;

+ }

+

+ /**

+ * if the option is prefixed with !, then the result becomes negated

+ * {@inheritDoc}

+ function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)

+ * @param phpbb_db_driver $db Database connection

+ public function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl);

+ * {@inheritDoc}

+ function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)

+ * {@inheritDoc}

+ function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)

+ /**

+ * Cache driver.

+ *

+ * @var phpbb_cache_driver_interface

+ */

+ protected $driver;

+

+ /**

+ * The config.

+ *

+ * @var phpbb_config

+ */

+ protected $config;

+

+ /**

+ * Database connection.

+ *

+ * @var phpbb_db_driver

+ */

+ protected $db;

+

+ /**

+ * Root path.

+ *

+ * @var string

+ */

+ protected $phpbb_root_path;

+

+ /**

+ * PHP extension.

+ *

+ * @var string

+ */

+ protected $php_ext;

+ * @param phpbb_config $config The config

+ * @param phpbb_db_driver $db Database connection

+ * @param string $phpbb_root_path Root path

+ * @param string $php_ext PHP extension

+ public function __construct(phpbb_cache_driver_interface $driver, phpbb_config $config, phpbb_db_driver $db, $phpbb_root_path, $php_ext)

+ $this->config = $config;

+ $this->db = $db;

+ $this->phpbb_root_path = $phpbb_root_path;

+ $this->php_ext = $php_ext;

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

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

+ $this->db->sql_freeresult($result);

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

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

+ $this->db->sql_freeresult($result);

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

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

+ $this->db->sql_freeresult($result);

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

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

+ $this->db->sql_freeresult($result);

+ switch ($this->db->sql_layer)

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

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

+ $this->db->sql_freeresult($result);

+ $filename = $this->phpbb_root_path . 'styles/' . $style['style_path'] . '/style.cfg';

+ if (!isset($parsed_array['filetime']) || (($this->config['load_tplcompile'] && @filemtime($filename) > $parsed_array['filetime'])))

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

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

+ $this->db->sql_freeresult($result);

+ for ($i = (int) floor($width / 2); $i < $end; $i++)

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ global $cache, $starttime, $phpbb_root_path, $phpbb_admin_path, $user;

+ <link href="' . htmlspecialchars($phpbb_admin_path) . 'style/admin.css" rel="stylesheet" type="text/css" media="screen" />

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ if ($cache && !is_object($query_id) && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $this->query_result = ($cache && $cache_ttl) ? $cache->sql_load($query) : false;

+ if ($cache && $cache_ttl)

+ $this->query_result = $cache->sql_save($this, $query, $this->query_result, $cache_ttl);

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ if ($cache && $cache->sql_exists($query_id))

+ $container->setParameter('core.adm_relative_path', (isset($phpbb_adm_relative_path) ? $phpbb_adm_relative_path : 'adm/'));

+ * @return mixed Returns false after last step, otherwise

+ * temporary state which is passed as an

+ * argument to the next step

+ new RecursiveDirectoryIterator($this->phpbb_root_path . 'ext/', FilesystemIterator::NEW_CURRENT_AND_KEY | FilesystemIterator::FOLLOW_SYMLINKS),

+ global $request, $phpbb_dispatcher, $phpbb_admin_path;

+ 'U_ACP' => ($auth->acl_get('a_') && !empty($user->data['is_registered'])) ? append_sid("{$phpbb_admin_path}index.$phpEx", false, true, $user->session_id) : '')

+ 'ICON_MOVE_UP' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_up.gif" alt="' . $user->lang['MOVE_UP'] . '" title="' . $user->lang['MOVE_UP'] . '" />',

+ 'ICON_MOVE_UP_DISABLED' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_up_disabled.gif" alt="' . $user->lang['MOVE_UP'] . '" title="' . $user->lang['MOVE_UP'] . '" />',

+ 'ICON_MOVE_DOWN' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_down.gif" alt="' . $user->lang['MOVE_DOWN'] . '" title="' . $user->lang['MOVE_DOWN'] . '" />',

+ 'ICON_MOVE_DOWN_DISABLED' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_down_disabled.gif" alt="' . $user->lang['MOVE_DOWN'] . '" title="' . $user->lang['MOVE_DOWN'] . '" />',

+ 'ICON_EDIT' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_edit.gif" alt="' . $user->lang['EDIT'] . '" title="' . $user->lang['EDIT'] . '" />',

+ 'ICON_EDIT_DISABLED' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_edit_disabled.gif" alt="' . $user->lang['EDIT'] . '" title="' . $user->lang['EDIT'] . '" />',

+ 'ICON_DELETE' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_delete.gif" alt="' . $user->lang['DELETE'] . '" title="' . $user->lang['DELETE'] . '" />',

+ 'ICON_DELETE_DISABLED' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_delete_disabled.gif" alt="' . $user->lang['DELETE'] . '" title="' . $user->lang['DELETE'] . '" />',

+ 'ICON_SYNC' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_sync.gif" alt="' . $user->lang['RESYNC'] . '" title="' . $user->lang['RESYNC'] . '" />',

+ 'ICON_SYNC_DISABLED' => '<img src="' . htmlspecialchars($phpbb_admin_path) . 'images/icon_sync_disabled.gif" alt="' . $user->lang['RESYNC'] . '" title="' . $user->lang['RESYNC'] . '" />',

+* Cache moderators. Called whenever permissions are changed

+* via admin_permissions. Changes of usernames and group names

+* must be carried through for the moderators table.

+*

+* @param phpbb_db_driver $db Database connection

+* @param phpbb_cache_driver_interface Cache driver

+* @param phpbb_auth $auth Authentication object

+* @return null

+function phpbb_cache_moderators($db, $cache, $auth)

+* Cache moderators. Called whenever permissions are changed

+* via admin_permissions. Changes of usernames and group names

+* must be carried through for the moderators table.

+*

+* @deprecated 3.1

+* @return null

+*/

+function cache_moderators()

+{

+ global $db, $cache, $auth;

+ return phpbb_cache_moderators($db, $cache, $auth);

+}

+

+/**

+* Removes moderators and administrators from foe lists.

+*

+* @param phpbb_db_driver $db Database connection

+* @param phpbb_auth $auth Authentication object

+* @param array|bool $group_id If an array, remove all members of this group from foe lists, or false to ignore

+* @param array|bool $user_id If an array, remove this user from foe lists, or false to ignore

+* @return null

+function phpbb_update_foes($db, $auth, $group_id = false, $user_id = false)

+* Removes moderators and administrators from foe lists.

+*

+* @deprecated 3.1

+* @param array|bool $group_id If an array, remove all members of this group from foe lists, or false to ignore

+* @param array|bool $user_id If an array, remove this user from foe lists, or false to ignore

+* @return null

+*/

+function update_foes($group_id = false, $user_id = false)

+{

+ global $db, $auth;

+ return phpbb_update_foes($db, $auth, $group_id, $user_id);

+}

+

+/**

+/**

+* Create a compiled and dumped ContainerBuilder object

+*

+* @param array $extensions Array of Container extension objects

+* @param array $passes Array of Compiler Pass objects

+* @param string $phpbb_root_path Root path

+* @param string $php_ext PHP Extension

+* @return ContainerBuilder object (compiled)

+*/

+/**

+* Create an environment-specific ContainerBuilder object

+*

+* If debug is enabled, the container is re-compiled every time.

+* This ensures that the latest changes will always be reflected

+* during development.

+*

+* Otherwise it will get the existing dumped container and use

+* that one instead.

+*

+* @param array $extensions Array of Container extension objects

+* @param array $passes Array of Compiler Pass objects

+* @param string $phpbb_root_path Root path

+* @param string $php_ext PHP Extension

+* @return ContainerBuilder object (compiled)

+*/

+/**

+* Create a default ContainerBuilder object

+*

+* Contains the default configuration of the phpBB container.

+*

+* @param array $extensions Array of Container extension objects

+* @param array $passes Array of Compiler Pass objects

+* @return ContainerBuilder object (compiled)

+*/

+function phpbb_create_default_container($phpbb_root_path, $php_ext)

+{

+ return phpbb_create_dumped_container_unless_debug(

+ array(

+ new phpbb_di_extension_config($phpbb_root_path . 'config.' . $php_ext),

+ new phpbb_di_extension_core($phpbb_root_path),

+ ),

+ array(

+ new phpbb_di_pass_collection_pass(),

+ new phpbb_di_pass_kernel_pass(),

+ ),

+ $phpbb_root_path,

+ $php_ext

+ );

+}

+

+/**

+* Get the filename under which the dumped container will be stored.

+*

+* @param string $phpbb_root_path Root path

+* @param string $php_ext PHP Extension

+* @return Path for dumped container

+*/

+ if ($request->is_ajax())

+ {

+ // Tell the ajax script what language vars and URL need to be replaced

+ $data = array(

+ 'NO_UNREAD_POSTS' => $user->lang['NO_UNREAD_POSTS'],

+ 'UNREAD_POSTS' => $user->lang['UNREAD_POSTS'],

+ 'U_MARK_FORUMS' => ($user->data['is_registered'] || $config['load_anon_lastread']) ? append_sid("{$phpbb_root_path}index.$phpEx", 'hash=' . generate_link_hash('global') . '&mark=forums&mark_time=' . time()) : '',

+ 'MESSAGE_TITLE' => $user->lang['INFORMATION'],

+ 'MESSAGE_TEXT' => $user->lang['FORUMS_MARKED']

+ );

+ $json_response = new phpbb_json_response();

+ $json_response->send($data);

+ }

+

+ if ($request->is_ajax())

+ {

+ // Tell the ajax script what language vars and URL need to be replaced

+ $data = array(

+ 'NO_UNREAD_POSTS' => $user->lang['NO_UNREAD_POSTS'],

+ 'UNREAD_POSTS' => $user->lang['UNREAD_POSTS'],

+ 'U_MARK_FORUMS' => ($user->data['is_registered'] || $config['load_anon_lastread']) ? append_sid("{$phpbb_root_path}viewforum.$phpEx", 'hash=' . generate_link_hash('global') . '&f=' . $root_data['forum_id'] . '&mark=forums&mark_time=' . time()) : '',

+ 'MESSAGE_TITLE' => $user->lang['INFORMATION'],

+ 'MESSAGE_TEXT' => $user->lang['FORUMS_MARKED']

+ );

+ $json_response = new phpbb_json_response();

+ $json_response->send($data);

+ }

+

+ // Note: php 5.5 alpha 2 deprecated mysql.

+ // Keep mysqli before mysql in this list.

+

+ 'adm_relative_path' => 'adm/',

+

+ // Check the permissions for post approval.

+ // Moderators must go through post approval like ordinary users.

+ if (!$auth->acl_get('f_noapprove', $data['forum_id']))

+ $this->extension = strtolower(self::get_extension($this->realname));

+ *

+ * @param string Filename that needs to be checked

+ * @return string Extension of the supplied filename

+ static public function get_extension($filename)

+ $types = fileupload::image_types();

+ * Get image type/extension mapping

+ *

+ * @return array Array containing the image types and their extensions

+ static public function image_types()

+ global $db, $cache, $auth, $phpbb_root_path, $phpEx, $phpbb_dispatcher;

+ if (!function_exists('phpbb_cache_moderators'))

+ phpbb_cache_moderators($db, $cache, $auth);

+ global $phpbb_container, $db, $phpbb_dispatcher;

+ $phpbb_container->get('cache.driver')->destroy('sql', MODERATOR_CACHE_TABLE);

+ global $db, $cache, $auth;

+ if (!function_exists('phpbb_cache_moderators'))

+ phpbb_cache_moderators($db, $cache, $auth);

+ if (!function_exists('phpbb_update_foes'))

+ phpbb_update_foes($db, $auth, array($group_id));

+<?php

+/**

+*

+* @package extension

+* @copyright (c) 2013 phpBB Group

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

+*

+*/

+

+/**

+* @ignore

+*/

+if (!defined('IN_PHPBB'))

+{

+ exit;

+}

+

+/**

+* The hook finder locates installed hooks.

+*

+* @package phpBB3

+*/

+class phpbb_hook_finder

+{

+ protected $phpbb_root_path;

+ protected $cache;

+ protected $php_ext;

+

+ /**

+ * Creates a new finder instance.

+ *

+ * @param string $phpbb_root_path Path to the phpbb root directory

+ * @param string $php_ext php file extension

+ * @param phpbb_cache_driver_interface $cache A cache instance or null

+ */

+ public function __construct($phpbb_root_path, $php_ext, phpbb_cache_driver_interface $cache = null)

+ {

+ $this->phpbb_root_path = $phpbb_root_path;

+ $this->cache = $cache;

+ $this->php_ext = $php_ext;

+ }

+

+ /**

+ * Finds all hook files.

+ *

+ * @param bool $cache Whether the result should be cached

+ * @return array An array of paths to found hook files

+ */

+ public function find($cache = true)

+ {

+ if (!defined('DEBUG') && $cache && $this->cache)

+ {

+ $hook_files = $this->cache->get('_hooks');

+ if ($hook_files !== false)

+ {

+ return $hook_files;

+ }

+ }

+

+ $hook_files = array();

+

+ // Now search for hooks...

+ $dh = @opendir($this->phpbb_root_path . 'includes/hooks/');

+

+ if ($dh)

+ {

+ while (($file = readdir($dh)) !== false)

+ {

+ if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($this->php_ext) + 1)) === '.' . $this->php_ext)

+ {

+ $hook_files[] = substr($file, 0, -(strlen($this->php_ext) + 1));

+ }

+ }

+ closedir($dh);

+ }

+

+ if ($cache && $this->cache)

+ {

+ $this->cache->put('_hooks', $hook_files);

+ }

+

+ return $hook_files;

+ }

+}

+

+ // Update the topic watch table.

+ // Update the bookmarks table.

+ phpbb_update_rows_avoiding_duplicates($db, BOOKMARKS_TABLE, 'topic_id', $topic_ids, $to_topic_id);

+

+ // Copy topic subscriptions to new topic

+

+ // Copy bookmarks to new topic

+ $sql = 'SELECT user_id

+ FROM ' . BOOKMARKS_TABLE . '

+ WHERE topic_id = ' . $topic_id;

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

+

+ $sql_ary = array();

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

+ {

+ $sql_ary[] = array(

+ 'topic_id' => (int) $new_topic_id,

+ 'user_id' => (int) $row['user_id'],

+ );

+ }

+ $db->sql_freeresult($result);

+

+ if (sizeof($sql_ary))

+ {

+ $db->sql_multi_insert(BOOKMARKS_TABLE, $sql_ary);

+ }

+ $report['report_text'] = make_clickable(bbcode_nl2br($report['report_text']));

+ $sql = 'SELECT r.post_id, r.user_id, r.report_id, r.report_closed, report_time, r.report_text, r.reported_post_text, r.reported_post_uid, r.reported_post_bitfield, r.reported_post_enable_magic_url, r.reported_post_enable_smilies, r.reported_post_enable_bbcode, rr.reason_title, rr.reason_description, u.username, u.username_clean, u.user_colour

+

+ $parse_post_flags = $report['reported_post_enable_bbcode'] ? OPTION_FLAG_BBCODE : 0;

+ $parse_post_flags += $report['reported_post_enable_smilies'] ? OPTION_FLAG_SMILIES : 0;

+ $parse_post_flags += $report['reported_post_enable_magic_url'] ? OPTION_FLAG_LINKS : 0;

+ parse_attachments($post_info['forum_id'], $report['reported_post_text'], $attachments, $update_count);

+ 'POST_PREVIEW' => generate_text_for_display($report['reported_post_text'], $report['reported_post_uid'], $report['reported_post_bitfield'], $parse_post_flags, false),

+ // Copy topic subscriptions to new topic

+ $sql = 'SELECT user_id, notify_status

+ FROM ' . TOPICS_WATCH_TABLE . '

+ WHERE topic_id = ' . $topic_id;

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

+

+ $sql_ary = array();

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

+ {

+ $sql_ary[] = array(

+ 'topic_id' => (int) $to_topic_id,

+ 'user_id' => (int) $row['user_id'],

+ 'notify_status' => (int) $row['notify_status'],

+ );

+ }

+ $db->sql_freeresult($result);

+

+ if (sizeof($sql_ary))

+ {

+ $db->sql_multi_insert(TOPICS_WATCH_TABLE, $sql_ary);

+ }

+

+ // Copy bookmarks to new topic

+ $sql = 'SELECT user_id

+ FROM ' . BOOKMARKS_TABLE . '

+ WHERE topic_id = ' . $topic_id;

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

+

+ $sql_ary = array();

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

+ {

+ $sql_ary[] = array(

+ 'topic_id' => (int) $to_topic_id,

+ 'user_id' => (int) $row['user_id'],

+ );

+ }

+ $db->sql_freeresult($result);

+

+ if (sizeof($sql_ary))

+ {

+ $db->sql_multi_insert(BOOKMARKS_TABLE, $sql_ary);

+ }

+

+

+ // If the topic no longer exist, we will update the topic watch table.

+

+ // If the topic no longer exist, we will update the bookmarks table.

+ phpbb_update_rows_avoiding_duplicates($db, BOOKMARKS_TABLE, 'topic_id', $topic_id, $to_topic_id);

+ $this->db->sql_transaction('begin');

+

+ $sql_from = "FROM $sql_from$sql_sort_table" . POSTS_TABLE . " p";

+ $sql_where = "WHERE (" . implode(' OR ', $tmp_sql_match) . ")

+ $sql_where_options";

+ $sql_from

+ $sql_where

+ $sql_count = "SELECT COUNT(*) as result_count

+ $sql_from

+ $sql_where";

+ $result = $this->db->sql_query($sql_count);

+ $result_count = (int) $this->db->sql_fetchfield('result_count');

+ $this->db->sql_freeresult($result);

+ $this->db->sql_transaction('commit');

+

+ $this->db->sql_transaction('begin');

+

+ if ($type == 'posts')

+ {

+ $sql_count = "SELECT COUNT(*) as result_count

+ FROM " . $sql_sort_table . POSTS_TABLE . ' p' . (($firstpost_only) ? ', ' . TOPICS_TABLE . ' t ' : ' ') . "

+ WHERE $sql_author

+ $sql_topic_id

+ $sql_firstpost

+ $m_approve_fid_sql

+ $sql_fora

+ $sql_sort_join

+ $sql_time";

+ }

+ else

+ {

+ $sql_count = "SELECT COUNT(*) as result_count

+ FROM " . $sql_sort_table . TOPICS_TABLE . ' t, ' . POSTS_TABLE . " p

+ WHERE $sql_author

+ $sql_topic_id

+ $sql_firstpost

+ $m_approve_fid_sql

+ $sql_fora

+ AND t.topic_id = p.topic_id

+ $sql_sort_join

+ $sql_time

+ GROUP BY t.topic_id, $sort_by_sql[$sort_key]";

+ }

+

+ $result = $this->db->sql_query($sql_count);

+ $result_count = (int) $this->db->sql_fetchfield('result_count');

+ $this->db->sql_transaction('commit');

+

+<?php

+

+//

+// $Id: sphinxapi.php 3087 2012-01-30 23:07:35Z shodan $

+//

+

+//

+// Copyright (c) 2001-2012, Andrew Aksyonoff

+// Copyright (c) 2008-2012, Sphinx Technologies Inc

+// All rights reserved

+//

+// This program is free software; you can redistribute it and/or modify

+// it under the terms of the GNU General Public License. You should have

+// received a copy of the GPL license along with this program; if you

+// did not, you can find it at http://www.gnu.org/

+//

+

+/////////////////////////////////////////////////////////////////////////////

+// PHP version of Sphinx searchd client (PHP API)

+/////////////////////////////////////////////////////////////////////////////

+

+/// known searchd commands

+define ( "SEARCHD_COMMAND_SEARCH", 0 );

+define ( "SEARCHD_COMMAND_EXCERPT", 1 );

+define ( "SEARCHD_COMMAND_UPDATE", 2 );

+define ( "SEARCHD_COMMAND_KEYWORDS", 3 );

+define ( "SEARCHD_COMMAND_PERSIST", 4 );

+define ( "SEARCHD_COMMAND_STATUS", 5 );

+define ( "SEARCHD_COMMAND_FLUSHATTRS", 7 );

+

+/// current client-side command implementation versions

+define ( "VER_COMMAND_SEARCH", 0x119 );

+define ( "VER_COMMAND_EXCERPT", 0x104 );

+define ( "VER_COMMAND_UPDATE", 0x102 );

+define ( "VER_COMMAND_KEYWORDS", 0x100 );

+define ( "VER_COMMAND_STATUS", 0x100 );

+define ( "VER_COMMAND_QUERY", 0x100 );

+define ( "VER_COMMAND_FLUSHATTRS", 0x100 );

+

+/// known searchd status codes

+define ( "SEARCHD_OK", 0 );

+define ( "SEARCHD_ERROR", 1 );

+define ( "SEARCHD_RETRY", 2 );

+define ( "SEARCHD_WARNING", 3 );

+

+/// known match modes

+define ( "SPH_MATCH_ALL", 0 );

+define ( "SPH_MATCH_ANY", 1 );

+define ( "SPH_MATCH_PHRASE", 2 );

+define ( "SPH_MATCH_BOOLEAN", 3 );

+define ( "SPH_MATCH_EXTENDED", 4 );

+define ( "SPH_MATCH_FULLSCAN", 5 );

+define ( "SPH_MATCH_EXTENDED2", 6 ); // extended engine V2 (TEMPORARY, WILL BE REMOVED)

+

+/// known ranking modes (ext2 only)

+define ( "SPH_RANK_PROXIMITY_BM25", 0 ); ///< default mode, phrase proximity major factor and BM25 minor one

+define ( "SPH_RANK_BM25", 1 ); ///< statistical mode, BM25 ranking only (faster but worse quality)

+define ( "SPH_RANK_NONE", 2 ); ///< no ranking, all matches get a weight of 1

+define ( "SPH_RANK_WORDCOUNT", 3 ); ///< simple word-count weighting, rank is a weighted sum of per-field keyword occurence counts

+define ( "SPH_RANK_PROXIMITY", 4 );

+define ( "SPH_RANK_MATCHANY", 5 );

+define ( "SPH_RANK_FIELDMASK", 6 );

+define ( "SPH_RANK_SPH04", 7 );

+define ( "SPH_RANK_EXPR", 8 );

+define ( "SPH_RANK_TOTAL", 9 );

+

+/// known sort modes

+define ( "SPH_SORT_RELEVANCE", 0 );

+define ( "SPH_SORT_ATTR_DESC", 1 );

+define ( "SPH_SORT_ATTR_ASC", 2 );

+define ( "SPH_SORT_TIME_SEGMENTS", 3 );

+define ( "SPH_SORT_EXTENDED", 4 );

+define ( "SPH_SORT_EXPR", 5 );

+

+/// known filter types

+define ( "SPH_FILTER_VALUES", 0 );

+define ( "SPH_FILTER_RANGE", 1 );

+define ( "SPH_FILTER_FLOATRANGE", 2 );

+

+/// known attribute types

+define ( "SPH_ATTR_INTEGER", 1 );

+define ( "SPH_ATTR_TIMESTAMP", 2 );

+define ( "SPH_ATTR_ORDINAL", 3 );

+define ( "SPH_ATTR_BOOL", 4 );

+define ( "SPH_ATTR_FLOAT", 5 );

+define ( "SPH_ATTR_BIGINT", 6 );

+define ( "SPH_ATTR_STRING", 7 );

+define ( "SPH_ATTR_MULTI", 0x40000001 );

+define ( "SPH_ATTR_MULTI64", 0x40000002 );

+

+/// known grouping functions

+define ( "SPH_GROUPBY_DAY", 0 );

+define ( "SPH_GROUPBY_WEEK", 1 );

+define ( "SPH_GROUPBY_MONTH", 2 );

+define ( "SPH_GROUPBY_YEAR", 3 );

+define ( "SPH_GROUPBY_ATTR", 4 );

+define ( "SPH_GROUPBY_ATTRPAIR", 5 );

+

+// important properties of PHP's integers:

+// - always signed (one bit short of PHP_INT_SIZE)

+// - conversion from string to int is saturated

+// - float is double

+// - div converts arguments to floats

+// - mod converts arguments to ints

+

+// the packing code below works as follows:

+// - when we got an int, just pack it

+// if performance is a problem, this is the branch users should aim for

+//

+// - otherwise, we got a number in string form

+// this might be due to different reasons, but we assume that this is

+// because it didn't fit into PHP int

+//

+// - factor the string into high and low ints for packing

+// - if we have bcmath, then it is used

+// - if we don't, we have to do it manually (this is the fun part)

+//

+// - x64 branch does factoring using ints

+// - x32 (ab)uses floats, since we can't fit unsigned 32-bit number into an int

+//

+// unpacking routines are pretty much the same.

+// - return ints if we can

+// - otherwise format number into a string

+

+/// pack 64-bit signed

+function sphPackI64 ( $v )

+{

+ assert ( is_numeric($v) );

+

+ // x64

+ if ( PHP_INT_SIZE>=8 )

+ {

+ $v = (int)$v;

+ return pack ( "NN", $v>>32, $v&0xFFFFFFFF );

+ }

+

+ // x32, int

+ if ( is_int($v) )

+ return pack ( "NN", $v < 0 ? -1 : 0, $v );

+

+ // x32, bcmath

+ if ( function_exists("bcmul") )

+ {

+ if ( bccomp ( $v, 0 ) == -1 )

+ $v = bcadd ( "18446744073709551616", $v );

+ $h = bcdiv ( $v, "4294967296", 0 );

+ $l = bcmod ( $v, "4294967296" );

+ return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit

+ }

+

+ // x32, no-bcmath

+ $p = max(0, strlen($v) - 13);

+ $lo = abs((float)substr($v, $p));

+ $hi = abs((float)substr($v, 0, $p));

+

+ $m = $lo + $hi*1316134912.0; // (10 ^ 13) % (1 << 32) = 1316134912

+ $q = floor($m/4294967296.0);

+ $l = $m - ($q*4294967296.0);

+ $h = $hi*2328.0 + $q; // (10 ^ 13) / (1 << 32) = 2328

+

+ if ( $v<0 )

+ {

+ if ( $l==0 )

+ $h = 4294967296.0 - $h;

+ else

+ {

+ $h = 4294967295.0 - $h;

+ $l = 4294967296.0 - $l;

+ }

+ }

+ return pack ( "NN", $h, $l );

+}

+

+/// pack 64-bit unsigned

+function sphPackU64 ( $v )

+{

+ assert ( is_numeric($v) );

+

+ // x64

+ if ( PHP_INT_SIZE>=8 )

+ {

+ assert ( $v>=0 );

+

+ // x64, int

+ if ( is_int($v) )

+ return pack ( "NN", $v>>32, $v&0xFFFFFFFF );

+

+ // x64, bcmath

+ if ( function_exists("bcmul") )

+ {

+ $h = bcdiv ( $v, 4294967296, 0 );

+ $l = bcmod ( $v, 4294967296 );

+ return pack ( "NN", $h, $l );

+ }

+

+ // x64, no-bcmath

+ $p = max ( 0, strlen($v) - 13 );

+ $lo = (int)substr ( $v, $p );

+ $hi = (int)substr ( $v, 0, $p );

+

+ $m = $lo + $hi*1316134912;

+ $l = $m % 4294967296;

+ $h = $hi*2328 + (int)($m/4294967296);

+

+ return pack ( "NN", $h, $l );

+ }

+

+ // x32, int

+ if ( is_int($v) )

+ return pack ( "NN", 0, $v );

+

+ // x32, bcmath

+ if ( function_exists("bcmul") )

+ {

+ $h = bcdiv ( $v, "4294967296", 0 );

+ $l = bcmod ( $v, "4294967296" );

+ return pack ( "NN", (float)$h, (float)$l ); // conversion to float is intentional; int would lose 31st bit

+ }

+

+ // x32, no-bcmath

+ $p = max(0, strlen($v) - 13);

+ $lo = (float)substr($v, $p);

+ $hi = (float)substr($v, 0, $p);

+

+ $m = $lo + $hi*1316134912.0;

+ $q = floor($m / 4294967296.0);

+ $l = $m - ($q * 4294967296.0);

+ $h = $hi*2328.0 + $q;

+

+ return pack ( "NN", $h, $l );

+}

+

+// unpack 64-bit unsigned

+function sphUnpackU64 ( $v )

+{

+ list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) );

+

+ if ( PHP_INT_SIZE>=8 )

+ {

+ if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again

+ if ( $lo<0 ) $lo += (1<<32);

+

+ // x64, int

+ if ( $hi<=2147483647 )

+ return ($hi<<32) + $lo;

+

+ // x64, bcmath

+ if ( function_exists("bcmul") )

+ return bcadd ( $lo, bcmul ( $hi, "4294967296" ) );

+

+ // x64, no-bcmath

+ $C = 100000;

+ $h = ((int)($hi / $C) << 32) + (int)($lo / $C);

+ $l = (($hi % $C) << 32) + ($lo % $C);

+ if ( $l>$C )

+ {

+ $h += (int)($l / $C);

+ $l = $l % $C;

+ }

+

+ if ( $h==0 )

+ return $l;

+ return sprintf ( "%d%05d", $h, $l );

+ }

+

+ // x32, int

+ if ( $hi==0 )

+ {

+ if ( $lo>0 )

+ return $lo;

+ return sprintf ( "%u", $lo );

+ }

+

+ $hi = sprintf ( "%u", $hi );

+ $lo = sprintf ( "%u", $lo );

+

+ // x32, bcmath

+ if ( function_exists("bcmul") )

+ return bcadd ( $lo, bcmul ( $hi, "4294967296" ) );

+

+ // x32, no-bcmath

+ $hi = (float)$hi;

+ $lo = (float)$lo;

+

+ $q = floor($hi/10000000.0);

+ $r = $hi - $q*10000000.0;

+ $m = $lo + $r*4967296.0;

+ $mq = floor($m/10000000.0);

+ $l = $m - $mq*10000000.0;

+ $h = $q*4294967296.0 + $r*429.0 + $mq;

+

+ $h = sprintf ( "%.0f", $h );

+ $l = sprintf ( "%07.0f", $l );

+ if ( $h=="0" )

+ return sprintf( "%.0f", (float)$l );

+ return $h . $l;

+}

+

+// unpack 64-bit signed

+function sphUnpackI64 ( $v )

+{

+ list ( $hi, $lo ) = array_values ( unpack ( "N*N*", $v ) );

+

+ // x64

+ if ( PHP_INT_SIZE>=8 )

+ {

+ if ( $hi<0 ) $hi += (1<<32); // because php 5.2.2 to 5.2.5 is totally fucked up again

+ if ( $lo<0 ) $lo += (1<<32);

+

+ return ($hi<<32) + $lo;

+ }

+

+ // x32, int

+ if ( $hi==0 )

+ {

+ if ( $lo>0 )

+ return $lo;

+ return sprintf ( "%u", $lo );

+ }

+ // x32, int

+ elseif ( $hi==-1 )

+ {

+ if ( $lo<0 )

+ return $lo;

+ return sprintf ( "%.0f", $lo - 4294967296.0 );

+ }

+

+ $neg = "";

+ $c = 0;

+ if ( $hi<0 )

+ {

+ $hi = ~$hi;

+ $lo = ~$lo;

+ $c = 1;

+ $neg = "-";

+ }

+

+ $hi = sprintf ( "%u", $hi );

+ $lo = sprintf ( "%u", $lo );

+

+ // x32, bcmath

+ if ( function_exists("bcmul") )

+ return $neg . bcadd ( bcadd ( $lo, bcmul ( $hi, "4294967296" ) ), $c );

+

+ // x32, no-bcmath

+ $hi = (float)$hi;

+ $lo = (float)$lo;

+

+ $q = floor($hi/10000000.0);

+ $r = $hi - $q*10000000.0;

+ $m = $lo + $r*4967296.0;

+ $mq = floor($m/10000000.0);

+ $l = $m - $mq*10000000.0 + $c;

+ $h = $q*4294967296.0 + $r*429.0 + $mq;

+ if ( $l==10000000 )

+ {

+ $l = 0;

+ $h += 1;

+ }

+

+ $h = sprintf ( "%.0f", $h );

+ $l = sprintf ( "%07.0f", $l );

+ if ( $h=="0" )

+ return $neg . sprintf( "%.0f", (float)$l );

+ return $neg . $h . $l;

+}

+

+

+function sphFixUint ( $value )

+{

+ if ( PHP_INT_SIZE>=8 )

+ {

+ // x64 route, workaround broken unpack() in 5.2.2+

+ if ( $value<0 ) $value += (1<<32);

+ return $value;

+ }

+ else

+ {

+ // x32 route, workaround php signed/unsigned braindamage

+ return sprintf ( "%u", $value );

+ }

+}

+

+

+/// sphinx searchd client class

+class SphinxClient

+{

+ var $_host; ///< searchd host (default is "localhost")

+ var $_port; ///< searchd port (default is 9312)

+ var $_offset; ///< how many records to seek from result-set start (default is 0)

+ var $_limit; ///< how many records to return from result-set starting at offset (default is 20)

+ var $_mode; ///< query matching mode (default is SPH_MATCH_ALL)

+ var $_weights; ///< per-field weights (default is 1 for all fields)

+ var $_sort; ///< match sorting mode (default is SPH_SORT_RELEVANCE)

+ var $_sortby; ///< attribute to sort by (defualt is "")

+ var $_min_id; ///< min ID to match (default is 0, which means no limit)

+ var $_max_id; ///< max ID to match (default is 0, which means no limit)

+ var $_filters; ///< search filters

+ var $_groupby; ///< group-by attribute name

+ var $_groupfunc; ///< group-by function (to pre-process group-by attribute value with)

+ var $_groupsort; ///< group-by sorting clause (to sort groups in result set with)

+ var $_groupdistinct;///< group-by count-distinct attribute

+ var $_maxmatches; ///< max matches to retrieve

+ var $_cutoff; ///< cutoff to stop searching at (default is 0)

+ var $_retrycount; ///< distributed retries count

+ var $_retrydelay; ///< distributed retries delay

+ var $_anchor; ///< geographical anchor point

+ var $_indexweights; ///< per-index weights

+ var $_ranker; ///< ranking mode (default is SPH_RANK_PROXIMITY_BM25)

+ var $_rankexpr; ///< ranking mode expression (for SPH_RANK_EXPR)

+ var $_maxquerytime; ///< max query time, milliseconds (default is 0, do not limit)

+ var $_fieldweights; ///< per-field-name weights

+ var $_overrides; ///< per-query attribute values overrides

+ var $_select; ///< select-list (attributes or expressions, with optional aliases)

+

+ var $_error; ///< last error message

+ var $_warning; ///< last warning message

+ var $_connerror; ///< connection error vs remote error flag

+

+ var $_reqs; ///< requests array for multi-query

+ var $_mbenc; ///< stored mbstring encoding

+ var $_arrayresult; ///< whether $result["matches"] should be a hash or an array

+ var $_timeout; ///< connect timeout

+

+ /////////////////////////////////////////////////////////////////////////////

+ // common stuff

+ /////////////////////////////////////////////////////////////////////////////

+

+ /// create a new client object and fill defaults

+ function SphinxClient ()

+ {

+ // per-client-object settings

+ $this->_host = "localhost";

+ $this->_port = 9312;

+ $this->_path = false;

+ $this->_socket = false;

+

+ // per-query settings

+ $this->_offset = 0;

+ $this->_limit = 20;

+ $this->_mode = SPH_MATCH_ALL;

+ $this->_weights = array ();

+ $this->_sort = SPH_SORT_RELEVANCE;

+ $this->_sortby = "";

+ $this->_min_id = 0;

+ $this->_max_id = 0;

+ $this->_filters = array ();

+ $this->_groupby = "";

+ $this->_groupfunc = SPH_GROUPBY_DAY;

+ $this->_groupsort = "@group desc";

+ $this->_groupdistinct= "";

+ $this->_maxmatches = 1000;

+ $this->_cutoff = 0;

+ $this->_retrycount = 0;

+ $this->_retrydelay = 0;

+ $this->_anchor = array ();

+ $this->_indexweights= array ();

+ $this->_ranker = SPH_RANK_PROXIMITY_BM25;

+ $this->_rankexpr = "";

+ $this->_maxquerytime= 0;

+ $this->_fieldweights= array();

+ $this->_overrides = array();

+ $this->_select = "*";

+

+ $this->_error = ""; // per-reply fields (for single-query case)

+ $this->_warning = "";

+ $this->_connerror = false;

+

+ $this->_reqs = array (); // requests storage (for multi-query case)

+ $this->_mbenc = "";

+ $this->_arrayresult = false;

+ $this->_timeout = 0;

+ }

+

+ function __destruct()

+ {

+ if ( $this->_socket !== false )

+ fclose ( $this->_socket );

+ }

+

+ /// get last error message (string)

+ function GetLastError ()

+ {

+ return $this->_error;

+ }

+

+ /// get last warning message (string)

+ function GetLastWarning ()

+ {

+ return $this->_warning;

+ }

+

+ /// get last error flag (to tell network connection errors from searchd errors or broken responses)

+ function IsConnectError()

+ {

+ return $this->_connerror;

+ }

+

+ /// set searchd host name (string) and port (integer)

+ function SetServer ( $host, $port = 0 )

+ {

+ assert ( is_string($host) );

+ if ( $host[0] == '/')

+ {

+ $this->_path = 'unix://' . $host;

+ return;

+ }

+ if ( substr ( $host, 0, 7 )=="unix://" )

+ {

+ $this->_path = $host;

+ return;

+ }

+

+ assert ( is_int($port) );

+ $this->_host = $host;

+ $this->_port = $port;

+ $this->_path = '';

+

+ }

+

+ /// set server connection timeout (0 to remove)

+ function SetConnectTimeout ( $timeout )

+ {

+ assert ( is_numeric($timeout) );

+ $this->_timeout = $timeout;

+ }

+

+

+ function _Send ( $handle, $data, $length )

+ {

+ if ( feof($handle) || fwrite ( $handle, $data, $length ) !== $length )

+ {

+ $this->_error = 'connection unexpectedly closed (timed out?)';

+ $this->_connerror = true;

+ return false;

+ }

+ return true;

+ }

+

+ /////////////////////////////////////////////////////////////////////////////

+

+ /// enter mbstring workaround mode

+ function _MBPush ()

+ {

+ $this->_mbenc = "";

+ if ( ini_get ( "mbstring.func_overload" ) & 2 )

+ {

+ $this->_mbenc = mb_internal_encoding();

+ mb_internal_encoding ( "latin1" );

+ }

+ }

+

+ /// leave mbstring workaround mode

+ function _MBPop ()

+ {

+ if ( $this->_mbenc )

+ mb_internal_encoding ( $this->_mbenc );

+ }

+

+ /// connect to searchd server

+ function _Connect ()

+ {

+ if ( $this->_socket!==false )

+ {

+ // we are in persistent connection mode, so we have a socket

+ // however, need to check whether it's still alive

+ if ( !@feof ( $this->_socket ) )

+ return $this->_socket;

+

+ // force reopen

+ $this->_socket = false;

+ }

+

+ $errno = 0;

+ $errstr = "";

+ $this->_connerror = false;

+

+ if ( $this->_path )

+ {

+ $host = $this->_path;

+ $port = 0;

+ }

+ else

+ {

+ $host = $this->_host;

+ $port = $this->_port;

+ }

+

+ if ( $this->_timeout<=0 )

+ $fp = @fsockopen ( $host, $port, $errno, $errstr );

+ else

+ $fp = @fsockopen ( $host, $port, $errno, $errstr, $this->_timeout );

+

+ if ( !$fp )

+ {

+ if ( $this->_path )

+ $location = $this->_path;

+ else

+ $location = "{$this->_host}:{$this->_port}";

+

+ $errstr = trim ( $errstr );

+ $this->_error = "connection to $location failed (errno=$errno, msg=$errstr)";

+ $this->_connerror = true;

+ return false;

+ }

+

+ // send my version

+ // this is a subtle part. we must do it before (!) reading back from searchd.

+ // because otherwise under some conditions (reported on FreeBSD for instance)

+ // TCP stack could throttle write-write-read pattern because of Nagle.

+ if ( !$this->_Send ( $fp, pack ( "N", 1 ), 4 ) )

+ {

+ fclose ( $fp );

+ $this->_error = "failed to send client protocol version";

+ return false;

+ }

+

+ // check version

+ list(,$v) = unpack ( "N*", fread ( $fp, 4 ) );

+ $v = (int)$v;

+ if ( $v<1 )

+ {

+ fclose ( $fp );

+ $this->_error = "expected searchd protocol version 1+, got version '$v'";

+ return false;

+ }

+

+ return $fp;

+ }

+

+ /// get and check response packet from searchd server

+ function _GetResponse ( $fp, $client_ver )

+ {

+ $response = "";

+ $len = 0;

+

+ $header = fread ( $fp, 8 );

+ if ( strlen($header)==8 )

+ {

+ list ( $status, $ver, $len ) = array_values ( unpack ( "n2a/Nb", $header ) );

+ $left = $len;

+ while ( $left>0 && !feof($fp) )

+ {

+ $chunk = fread ( $fp, min ( 8192, $left ) );

+ if ( $chunk )

+ {

+ $response .= $chunk;

+ $left -= strlen($chunk);

+ }

+ }

+ }

+ if ( $this->_socket === false )

+ fclose ( $fp );

+

+ // check response

+ $read = strlen ( $response );

+ if ( !$response || $read!=$len )

+ {

+ $this->_error = $len

+ ? "failed to read searchd response (status=$status, ver=$ver, len=$len, read=$read)"

+ : "received zero-sized searchd response";

+ return false;

+ }

+

+ // check status

+ if ( $status==SEARCHD_WARNING )

+ {

+ list(,$wlen) = unpack ( "N*", substr ( $response, 0, 4 ) );

+ $this->_warning = substr ( $response, 4, $wlen );

+ return substr ( $response, 4+$wlen );

+ }

+ if ( $status==SEARCHD_ERROR )

+ {

+ $this->_error = "searchd error: " . substr ( $response, 4 );

+ return false;

+ }

+ if ( $status==SEARCHD_RETRY )

+ {

+ $this->_error = "temporary searchd error: " . substr ( $response, 4 );

+ return false;

+ }

+ if ( $status!=SEARCHD_OK )

+ {

+ $this->_error = "unknown status code '$status'";

+ return false;

+ }

+

+ // check version

+ if ( $ver<$client_ver )

+ {

+ $this->_warning = sprintf ( "searchd command v.%d.%d older than client's v.%d.%d, some options might not work",

+ $ver>>8, $ver&0xff, $client_ver>>8, $client_ver&0xff );

+ }

+

+ return $response;

+ }

+

+ /////////////////////////////////////////////////////////////////////////////

+ // searching

+ /////////////////////////////////////////////////////////////////////////////

+

+ /// set offset and count into result set,

+ /// and optionally set max-matches and cutoff limits

+ function SetLimits ( $offset, $limit, $max=0, $cutoff=0 )

+ {

+ assert ( is_int($offset) );

+ assert ( is_int($limit) );

+ assert ( $offset>=0 );

+ assert ( $limit>0 );

+ assert ( $max>=0 );

+ $this->_offset = $offset;

+ $this->_limit = $limit;

+ if ( $max>0 )

+ $this->_maxmatches = $max;

+ if ( $cutoff>0 )

+ $this->_cutoff = $cutoff;

+ }

+

+ /// set maximum query time, in milliseconds, per-index

+ /// integer, 0 means "do not limit"

+ function SetMaxQueryTime ( $max )

+ {

+ assert ( is_int($max) );

+ assert ( $max>=0 );

+ $this->_maxquerytime = $max;

+ }

+

+ /// set matching mode

+ function SetMatchMode ( $mode )

+ {

+ assert ( $mode==SPH_MATCH_ALL

+ || $mode==SPH_MATCH_ANY

+ || $mode==SPH_MATCH_PHRASE

+ || $mode==SPH_MATCH_BOOLEAN

+ || $mode==SPH_MATCH_EXTENDED

+ || $mode==SPH_MATCH_FULLSCAN

+ || $mode==SPH_MATCH_EXTENDED2 );

+ $this->_mode = $mode;

+ }

+

+ /// set ranking mode

+ function SetRankingMode ( $ranker, $rankexpr="" )

+ {

+ assert ( $ranker>=0 && $ranker<SPH_RANK_TOTAL );

+ assert ( is_string($rankexpr) );

+ $this->_ranker = $ranker;

+ $this->_rankexpr = $rankexpr;

+ }

+

+ /// set matches sorting mode

+ function SetSortMode ( $mode, $sortby="" )

+ {

+ assert (

+ $mode==SPH_SORT_RELEVANCE ||

+ $mode==SPH_SORT_ATTR_DESC ||

+ $mode==SPH_SORT_ATTR_ASC ||

+ $mode==SPH_SORT_TIME_SEGMENTS ||

+ $mode==SPH_SORT_EXTENDED ||

+ $mode==SPH_SORT_EXPR );

+ assert ( is_string($sortby) );

+ assert ( $mode==SPH_SORT_RELEVANCE || strlen($sortby)>0 );

+

+ $this->_sort = $mode;

+ $this->_sortby = $sortby;

+ }

+

+ /// bind per-field weights by order

+ /// DEPRECATED; use SetFieldWeights() instead

+ function SetWeights ( $weights )

+ {

+ assert ( is_array($weights) );

+ foreach ( $weights as $weight )

+ assert ( is_int($weight) );

+

+ $this->_weights = $weights;

+ }

+

+ /// bind per-field weights by name

+ function SetFieldWeights ( $weights )

+ {

+ assert ( is_array($weights) );

+ foreach ( $weights as $name=>$weight )

+ {

+ assert ( is_string($name) );

+ assert ( is_int($weight) );

+ }

+ $this->_fieldweights = $weights;

+ }

+

+ /// bind per-index weights by name

+ function SetIndexWeights ( $weights )

+ {

+ assert ( is_array($weights) );

+ foreach ( $weights as $index=>$weight )

+ {

+ assert ( is_string($index) );

+ assert ( is_int($weight) );

+ }

+ $this->_indexweights = $weights;

+ }

+

+ /// set IDs range to match

+ /// only match records if document ID is beetwen $min and $max (inclusive)

+ function SetIDRange ( $min, $max )

+ {

+ assert ( is_numeric($min) );

+ assert ( is_numeric($max) );

+ assert ( $min<=$max );

+ $this->_min_id = $min;

+ $this->_max_id = $max;

+ }

+

+ /// set values set filter

+ /// only match records where $attribute value is in given set

+ function SetFilter ( $attribute, $values, $exclude=false )

+ {

+ assert ( is_string($attribute) );

+ assert ( is_array($values) );

+ assert ( count($values) );

+

+ if ( is_array($values) && count($values) )

+ {

+ foreach ( $values as $value )

+ assert ( is_numeric($value) );

+

+ $this->_filters[] = array ( "type"=>SPH_FILTER_VALUES, "attr"=>$attribute, "exclude"=>$exclude, "values"=>$values );

+ }

+ }

+

+ /// set range filter

+ /// only match records if $attribute value is beetwen $min and $max (inclusive)

+ function SetFilterRange ( $attribute, $min, $max, $exclude=false )

+ {

+ assert ( is_string($attribute) );

+ assert ( is_numeric($min) );

+ assert ( is_numeric($max) );

+ assert ( $min<=$max );

+

+ $this->_filters[] = array ( "type"=>SPH_FILTER_RANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max );

+ }

+

+ /// set float range filter

+ /// only match records if $attribute value is beetwen $min and $max (inclusive)

+ function SetFilterFloatRange ( $attribute, $min, $max, $exclude=false )

+ {

+ assert ( is_string($attribute) );

+ assert ( is_float($min) );

+ assert ( is_float($max) );

+ assert ( $min<=$max );

+

+ $this->_filters[] = array ( "type"=>SPH_FILTER_FLOATRANGE, "attr"=>$attribute, "exclude"=>$exclude, "min"=>$min, "max"=>$max );

+ }

+

+ /// setup anchor point for geosphere distance calculations

+ /// required to use @geodist in filters and sorting

+ /// latitude and longitude must be in radians

+ function SetGeoAnchor ( $attrlat, $attrlong, $lat, $long )

+ {

+ assert ( is_string($attrlat) );

+ assert ( is_string($attrlong) );

+ assert ( is_float($lat) );

+ assert ( is_float($long) );

+

+ $this->_anchor = array ( "attrlat"=>$attrlat, "attrlong"=>$attrlong, "lat"=>$lat, "long"=>$long );

+ }

+

+ /// set grouping attribute and function

+ function SetGroupBy ( $attribute, $func, $groupsort="@group desc" )

+ {

+ assert ( is_string($attribute) );

+ assert ( is_string($groupsort) );

+ assert ( $func==SPH_GROUPBY_DAY

+ || $func==SPH_GROUPBY_WEEK

+ || $func==SPH_GROUPBY_MONTH

+ || $func==SPH_GROUPBY_YEAR

+ || $func==SPH_GROUPBY_ATTR

+ || $func==SPH_GROUPBY_ATTRPAIR );

+

+ $this->_groupby = $attribute;

+ $this->_groupfunc = $func;

+ $this->_groupsort = $groupsort;

+ }

+

+ /// set count-distinct attribute for group-by queries

+ function SetGroupDistinct ( $attribute )

+ {

+ assert ( is_string($attribute) );

+ $this->_groupdistinct = $attribute;

+ }

+

+ /// set distributed retries count and delay

+ function SetRetries ( $count, $delay=0 )

+ {

+ assert ( is_int($count) && $count>=0 );

+ assert ( is_int($delay) && $delay>=0 );

+ $this->_retrycount = $count;

+ $this->_retrydelay = $delay;

+ }

+

+ /// set result set format (hash or array; hash by default)

+ /// PHP specific; needed for group-by-MVA result sets that may contain duplicate IDs

+ function SetArrayResult ( $arrayresult )

+ {

+ assert ( is_bool($arrayresult) );

+ $this->_arrayresult = $arrayresult;

+ }

+

+ /// set attribute values override

+ /// there can be only one override per attribute

+ /// $values must be a hash that maps document IDs to attribute values

+ function SetOverride ( $attrname, $attrtype, $values )

+ {

+ assert ( is_string ( $attrname ) );

+ assert ( in_array ( $attrtype, array ( SPH_ATTR_INTEGER, SPH_ATTR_TIMESTAMP, SPH_ATTR_BOOL, SPH_ATTR_FLOAT, SPH_ATTR_BIGINT ) ) );

+ assert ( is_array ( $values ) );

+

+ $this->_overrides[$attrname] = array ( "attr"=>$attrname, "type"=>$attrtype, "values"=>$values );

+ }

+

+ /// set select-list (attributes or expressions), SQL-like syntax

+ function SetSelect ( $select )

+ {

+ assert ( is_string ( $select ) );

+ $this->_select = $select;

+ }

+

+ //////////////////////////////////////////////////////////////////////////////

+

+ /// clear all filters (for multi-queries)

+ function ResetFilters ()

+ {

+ $this->_filters = array();

+ $this->_anchor = array();

+ }

+

+ /// clear groupby settings (for multi-queries)

+ function ResetGroupBy ()

+ {

+ $this->_groupby = "";

+ $this->_groupfunc = SPH_GROUPBY_DAY;

+ $this->_groupsort = "@group desc";

+ $this->_groupdistinct= "";

+ }

+

+ /// clear all attribute value overrides (for multi-queries)

+ function ResetOverrides ()

+ {

+ $this->_overrides = array ();

+ }

+

+ //////////////////////////////////////////////////////////////////////////////

+

+ /// connect to searchd server, run given search query through given indexes,

+ /// and return the search results

+ function Query ( $query, $index="*", $comment="" )

+ {

+ assert ( empty($this->_reqs) );

+

+ $this->AddQuery ( $query, $index, $comment );

+ $results = $this->RunQueries ();

+ $this->_reqs = array (); // just in case it failed too early

+

+ if ( !is_array($results) )

+ return false; // probably network error; error message should be already filled

+

+ $this->_error = $results[0]["error"];

+ $this->_warning = $results[0]["warning"];

+ if ( $results[0]["status"]==SEARCHD_ERROR )

+ return false;

+ else

+ return $results[0];

+ }

+

+ /// helper to pack floats in network byte order

+ function _PackFloat ( $f )

+ {

+ $t1 = pack ( "f", $f ); // machine order

+ list(,$t2) = unpack ( "L*", $t1 ); // int in machine order

+ return pack ( "N", $t2 );

+ }

+

+ /// add query to multi-query batch

+ /// returns index into results array from RunQueries() call

+ function AddQuery ( $query, $index="*", $comment="" )

+ {

+ // mbstring workaround

+ $this->_MBPush ();

+

+ // build request

+ $req = pack ( "NNNN", $this->_offset, $this->_limit, $this->_mode, $this->_ranker );

+ if ( $this->_ranker==SPH_RANK_EXPR )

+ $req .= pack ( "N", strlen($this->_rankexpr) ) . $this->_rankexpr;

+ $req .= pack ( "N", $this->_sort ); // (deprecated) sort mode

+ $req .= pack ( "N", strlen($this->_sortby) ) . $this->_sortby;

+ $req .= pack ( "N", strlen($query) ) . $query; // query itself

+ $req .= pack ( "N", count($this->_weights) ); // weights

+ foreach ( $this->_weights as $weight )

+ $req .= pack ( "N", (int)$weight );

+ $req .= pack ( "N", strlen($index) ) . $index; // indexes

+ $req .= pack ( "N", 1 ); // id64 range marker

+ $req .= sphPackU64 ( $this->_min_id ) . sphPackU64 ( $this->_max_id ); // id64 range

+

+ // filters

+ $req .= pack ( "N", count($this->_filters) );

+ foreach ( $this->_filters as $filter )

+ {

+ $req .= pack ( "N", strlen($filter["attr"]) ) . $filter["attr"];

+ $req .= pack ( "N", $filter["type"] );

+ switch ( $filter["type"] )

+ {

+ case SPH_FILTER_VALUES:

+ $req .= pack ( "N", count($filter["values"]) );

+ foreach ( $filter["values"] as $value )

+ $req .= sphPackI64 ( $value );

+ break;

+

+ case SPH_FILTER_RANGE:

+ $req .= sphPackI64 ( $filter["min"] ) . sphPackI64 ( $filter["max"] );

+ break;

+

+ case SPH_FILTER_FLOATRANGE:

+ $req .= $this->_PackFloat ( $filter["min"] ) . $this->_PackFloat ( $filter["max"] );

+ break;

+

+ default:

+ assert ( 0 && "internal error: unhandled filter type" );

+ }

+ $req .= pack ( "N", $filter["exclude"] );

+ }

+

+ // group-by clause, max-matches count, group-sort clause, cutoff count

+ $req .= pack ( "NN", $this->_groupfunc, strlen($this->_groupby) ) . $this->_groupby;

+ $req .= pack ( "N", $this->_maxmatches );

+ $req .= pack ( "N", strlen($this->_groupsort) ) . $this->_groupsort;

+ $req .= pack ( "NNN", $this->_cutoff, $this->_retrycount, $this->_retrydelay );

+ $req .= pack ( "N", strlen($this->_groupdistinct) ) . $this->_groupdistinct;

+

+ // anchor point

+ if ( empty($this->_anchor) )

+ {

+ $req .= pack ( "N", 0 );

+ } else

+ {

+ $a =& $this->_anchor;

+ $req .= pack ( "N", 1 );

+ $req .= pack ( "N", strlen($a["attrlat"]) ) . $a["attrlat"];

+ $req .= pack ( "N", strlen($a["attrlong"]) ) . $a["attrlong"];

+ $req .= $this->_PackFloat ( $a["lat"] ) . $this->_PackFloat ( $a["long"] );

+ }

+

+ // per-index weights

+ $req .= pack ( "N", count($this->_indexweights) );

+ foreach ( $this->_indexweights as $idx=>$weight )

+ $req .= pack ( "N", strlen($idx) ) . $idx . pack ( "N", $weight );

+

+ // max query time

+ $req .= pack ( "N", $this->_maxquerytime );

+

+ // per-field weights

+ $req .= pack ( "N", count($this->_fieldweights) );

+ foreach ( $this->_fieldweights as $field=>$weight )

+ $req .= pack ( "N", strlen($field) ) . $field . pack ( "N", $weight );

+

+ // comment

+ $req .= pack ( "N", strlen($comment) ) . $comment;

+

+ // attribute overrides

+ $req .= pack ( "N", count($this->_overrides) );

+ foreach ( $this->_overrides as $key => $entry )

+ {

+ $req .= pack ( "N", strlen($entry["attr"]) ) . $entry["attr"];

+ $req .= pack ( "NN", $entry["type"], count($entry["values"]) );

+ foreach ( $entry["values"] as $id=>$val )

+ {

+ assert ( is_numeric($id) );

+ assert ( is_numeric($val) );

+

+ $req .= sphPackU64 ( $id );

+ switch ( $entry["type"] )

+ {

+ case SPH_ATTR_FLOAT: $req .= $this->_PackFloat ( $val ); break;

+ case SPH_ATTR_BIGINT: $req .= sphPackI64 ( $val ); break;

+ default: $req .= pack ( "N", $val ); break;

+ }

+ }

+ }

+

+ // select-list

+ $req .= pack ( "N", strlen($this->_select) ) . $this->_select;

+

+ // mbstring workaround

+ $this->_MBPop ();

+

+ // store request to requests array

+ $this->_reqs[] = $req;

+ return count($this->_reqs)-1;

+ }

+

+ /// connect to searchd, run queries batch, and return an array of result sets

+ function RunQueries ()

+ {

+ if ( empty($this->_reqs) )

+ {

+ $this->_error = "no queries defined, issue AddQuery() first";

+ return false;

+ }

+

+ // mbstring workaround

+ $this->_MBPush ();

+

+ if (!( $fp = $this->_Connect() ))

+ {

+ $this->_MBPop ();

+ return false;

+ }

+

+ // send query, get response

+ $nreqs = count($this->_reqs);

+ $req = join ( "", $this->_reqs );

+ $len = 8+strlen($req);

+ $req = pack ( "nnNNN", SEARCHD_COMMAND_SEARCH, VER_COMMAND_SEARCH, $len, 0, $nreqs ) . $req; // add header

+

+ if ( !( $this->_Send ( $fp, $req, $len+8 ) ) ||

+ !( $response = $this->_GetResponse ( $fp, VER_COMMAND_SEARCH ) ) )

+ {

+ $this->_MBPop ();

+ return false;

+ }

+

+ // query sent ok; we can reset reqs now

+ $this->_reqs = array ();

+

+ // parse and return response

+ return $this->_ParseSearchResponse ( $response, $nreqs );

+ }

+

+ /// parse and return search query (or queries) response

+ function _ParseSearchResponse ( $response, $nreqs )

+ {

+ $p = 0; // current position

+ $max = strlen($response); // max position for checks, to protect against broken responses

+

+ $results = array ();

+ for ( $ires=0; $ires<$nreqs && $p<$max; $ires++ )

+ {

+ $results[] = array();

+ $result =& $results[$ires];

+

+ $result["error"] = "";

+ $result["warning"] = "";

+

+ // extract status

+ list(,$status) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $result["status"] = $status;

+ if ( $status!=SEARCHD_OK )

+ {

+ list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $message = substr ( $response, $p, $len ); $p += $len;

+

+ if ( $status==SEARCHD_WARNING )

+ {

+ $result["warning"] = $message;

+ } else

+ {

+ $result["error"] = $message;

+ continue;

+ }

+ }

+

+ // read schema

+ $fields = array ();

+ $attrs = array ();

+

+ list(,$nfields) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ while ( $nfields-->0 && $p<$max )

+ {

+ list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $fields[] = substr ( $response, $p, $len ); $p += $len;

+ }

+ $result["fields"] = $fields;

+

+ list(,$nattrs) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ while ( $nattrs-->0 && $p<$max )

+ {

+ list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $attr = substr ( $response, $p, $len ); $p += $len;

+ list(,$type) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $attrs[$attr] = $type;

+ }

+ $result["attrs"] = $attrs;

+

+ // read match count

+ list(,$count) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ list(,$id64) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+

+ // read matches

+ $idx = -1;

+ while ( $count-->0 && $p<$max )

+ {

+ // index into result array

+ $idx++;

+

+ // parse document id and weight

+ if ( $id64 )

+ {

+ $doc = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8;

+ list(,$weight) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ }

+ else

+ {

+ list ( $doc, $weight ) = array_values ( unpack ( "N*N*",

+ substr ( $response, $p, 8 ) ) );

+ $p += 8;

+ $doc = sphFixUint($doc);

+ }

+ $weight = sprintf ( "%u", $weight );

+

+ // create match entry

+ if ( $this->_arrayresult )

+ $result["matches"][$idx] = array ( "id"=>$doc, "weight"=>$weight );

+ else

+ $result["matches"][$doc]["weight"] = $weight;

+

+ // parse and create attributes

+ $attrvals = array ();

+ foreach ( $attrs as $attr=>$type )

+ {

+ // handle 64bit ints

+ if ( $type==SPH_ATTR_BIGINT )

+ {

+ $attrvals[$attr] = sphUnpackI64 ( substr ( $response, $p, 8 ) ); $p += 8;

+ continue;

+ }

+

+ // handle floats

+ if ( $type==SPH_ATTR_FLOAT )

+ {

+ list(,$uval) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ list(,$fval) = unpack ( "f*", pack ( "L", $uval ) );

+ $attrvals[$attr] = $fval;

+ continue;

+ }

+

+ // handle everything else as unsigned ints

+ list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ if ( $type==SPH_ATTR_MULTI )

+ {

+ $attrvals[$attr] = array ();

+ $nvalues = $val;

+ while ( $nvalues-->0 && $p<$max )

+ {

+ list(,$val) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $attrvals[$attr][] = sphFixUint($val);

+ }

+ } else if ( $type==SPH_ATTR_MULTI64 )

+ {

+ $attrvals[$attr] = array ();

+ $nvalues = $val;

+ while ( $nvalues>0 && $p<$max )

+ {

+ $attrvals[$attr][] = sphUnpackU64 ( substr ( $response, $p, 8 ) ); $p += 8;

+ $nvalues -= 2;

+ }

+ } else if ( $type==SPH_ATTR_STRING )

+ {

+ $attrvals[$attr] = substr ( $response, $p, $val );

+ $p += $val;

+ } else

+ {

+ $attrvals[$attr] = sphFixUint($val);

+ }

+ }

+

+ if ( $this->_arrayresult )

+ $result["matches"][$idx]["attrs"] = $attrvals;

+ else

+ $result["matches"][$doc]["attrs"] = $attrvals;

+ }

+

+ list ( $total, $total_found, $msecs, $words ) =

+ array_values ( unpack ( "N*N*N*N*", substr ( $response, $p, 16 ) ) );

+ $result["total"] = sprintf ( "%u", $total );

+ $result["total_found"] = sprintf ( "%u", $total_found );

+ $result["time"] = sprintf ( "%.3f", $msecs/1000 );

+ $p += 16;

+

+ while ( $words-->0 && $p<$max )

+ {

+ list(,$len) = unpack ( "N*", substr ( $response, $p, 4 ) ); $p += 4;

+ $word = substr ( $response, $p, $len ); $p += $len;

+ list ( $docs, $hits ) = array_values ( unpack ( "N*N*", substr ( $response, $p, 8 ) ) ); $p += 8;

+ $result["words"][$word] = array (

+ "docs"=>sprintf ( "%u", $docs ),

+ "hits"=>sprintf ( "%u", $hits ) );

+ }

+ }

+

+ $this->_MBPop ();

+ return $results;

+ }