File sources/subs/SearchEngines.subs.php | ElkArte 1.1.1 Documentation

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656

<?php

/**
 * This file contains all the screens that relate to search engines.
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * This file contains code covered by:
 * copyright:   2011 Simple Machines (http://www.simplemachines.org)
 * license:     BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version 1.1
 *
 */

/**
 * Do we think the current user is a spider?
 *
 * @package SearchEngines
 * @return int
 */
function spiderCheck()
{
    global $modSettings;

    $db = database();

    if (isset($_SESSION['id_robot']))
        unset($_SESSION['id_robot']);

    $_SESSION['robot_check'] = time();

    // We cache the spider data for five minutes if we can.
    $spider_data = array();
    $cache = Cache::instance();
    if (!$cache->getVar($spider_data, 'spider_search', 300))
    {
        $request = $db->query('', '
            SELECT id_spider, user_agent, ip_info
            FROM {db_prefix}spiders
            ORDER BY LENGTH(user_agent) DESC',
            array(
            )
        );
        while ($row = $db->fetch_assoc($request))
            $spider_data[] = $row;
        $db->free_result($request);

        // Save it in the cache
        $cache->put('spider_search', $spider_data, 300);
    }

    if (empty($spider_data))
        return false;

    // We need the user agent
    $req = request();

    // Always attempt IPv6 first.
    if (strpos($_SERVER['REMOTE_ADDR'], ':') !== false)
        $ip_parts = convertIPv6toInts($_SERVER['REMOTE_ADDR']);
    // Then xxx.xxx.xxx.xxx next
    else
        preg_match('/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $_SERVER['REMOTE_ADDR'], $ip_parts);

    foreach ($spider_data as $spider)
    {
        // User agent is easy.
        if (!empty($spider['user_agent']) && strpos(strtolower($req->user_agent()), strtolower($spider['user_agent'])) !== false)
            $_SESSION['id_robot'] = $spider['id_spider'];
        // IP stuff is harder.
        elseif (!empty($ip_parts))
        {
            $ips = explode(',', $spider['ip_info']);
            foreach ($ips as $ip)
            {
                $ip = ip2range($ip);
                if (!empty($ip))
                {
                    foreach ($ip as $key => $value)
                    {
                        if ($value['low'] > $ip_parts[$key + 1] || $value['high'] < $ip_parts[$key + 1])
                            break;
                        elseif (($key == 7 && strpos($_SERVER['REMOTE_ADDR'], ':') !== false) || ($key == 3 && strpos($_SERVER['REMOTE_ADDR'], ':') === false))
                            $_SESSION['id_robot'] = $spider['id_spider'];
                    }
                }
            }
        }

        if (isset($_SESSION['id_robot']))
            break;
    }

    // If this is low server tracking then log the spider here as opposed to the main logging function.
    if (!empty($modSettings['spider_mode']) && $modSettings['spider_mode'] == 1 && !empty($_SESSION['id_robot']))
        logSpider();

    return !empty($_SESSION['id_robot']) ? $_SESSION['id_robot'] : 0;
}

/**
 * Log the spider presence online.
 *
 * @package SearchEngines
 */
function logSpider()
{
    global $modSettings, $context;

    $db = database();

    if (empty($modSettings['spider_mode']) || empty($_SESSION['id_robot']))
        return;

    // Attempt to update today's entry.
    if ($modSettings['spider_mode'] == 1)
    {
        $date = strftime('%Y-%m-%d', forum_time(false));
        $db->query('', '
            UPDATE {db_prefix}log_spider_stats
            SET last_seen = {int:current_time}, page_hits = page_hits + 1
            WHERE id_spider = {int:current_spider}
                AND stat_date = {date:current_date}',
            array(
                'current_date' => $date,
                'current_time' => time(),
                'current_spider' => $_SESSION['id_robot'],
            )
        );
        // Nothing updated?
        if ($db->affected_rows() == 0)
        {
            $db->insert('ignore',
                '{db_prefix}log_spider_stats',
                array(
                    'id_spider' => 'int', 'last_seen' => 'int', 'stat_date' => 'date', 'page_hits' => 'int',
                ),
                array(
                    $_SESSION['id_robot'], time(), $date, 1,
                ),
                array('id_spider', 'stat_date')
            );
        }
    }
    // If we're tracking better stats than track, better stats - we sort out the today thing later.
    else
    {
        if ($modSettings['spider_mode'] > 2)
        {
            $url = $_GET;
            if (isset($context['session_var']))
                unset($url['sesc'], $url[$context['session_var']]);
            else
                unset($url['sesc']);
            $url = serialize($url);
        }
        else
            $url = '';

        $db->insert('insert',
            '{db_prefix}log_spider_hits',
            array('id_spider' => 'int', 'log_time' => 'int', 'url' => 'string'),
            array($_SESSION['id_robot'], time(), $url),
            array()
        );
    }
}

/**
 * This function takes any unprocessed hits and updates stats accordingly.
 *
 * @package SearchEngines
 */
function consolidateSpiderStats()
{
    $db = database();

    $request = $db->query('consolidate_spider_stats', '
        SELECT id_spider, MAX(log_time) AS last_seen, COUNT(*) AS num_hits
        FROM {db_prefix}log_spider_hits
        WHERE processed = {int:not_processed}
        GROUP BY id_spider, MONTH(log_time), DAYOFMONTH(log_time)',
        array(
            'not_processed' => 0,
        )
    );
    $spider_hits = array();
    while ($row = $db->fetch_assoc($request))
        $spider_hits[] = $row;
    $db->free_result($request);

    if (empty($spider_hits))
        return;

    // Attempt to update the master data.
    $stat_inserts = array();
    foreach ($spider_hits as $stat)
    {
        // We assume the max date is within the right day.
        $date = strftime('%Y-%m-%d', $stat['last_seen']);
        $db->query('', '
            UPDATE {db_prefix}log_spider_stats
            SET page_hits = page_hits + ' . $stat['num_hits'] . ',
                last_seen = CASE WHEN last_seen > {int:last_seen} THEN last_seen ELSE {int:last_seen} END
            WHERE id_spider = {int:current_spider}
                AND stat_date = {date:last_seen_date}',
            array(
                'last_seen_date' => $date,
                'last_seen' => $stat['last_seen'],
                'current_spider' => $stat['id_spider'],
            )
        );
        if ($db->affected_rows() == 0)
            $stat_inserts[] = array($date, $stat['id_spider'], $stat['num_hits'], $stat['last_seen']);
    }

    // New stats?
    if (!empty($stat_inserts))
        $db->insert('ignore',
            '{db_prefix}log_spider_stats',
            array('stat_date' => 'date', 'id_spider' => 'int', 'page_hits' => 'int', 'last_seen' => 'int'),
            $stat_inserts,
            array('stat_date', 'id_spider')
        );

    // All processed.
    $db->query('', '
        UPDATE {db_prefix}log_spider_hits
        SET processed = {int:is_processed}
        WHERE processed = {int:not_processed}',
        array(
            'is_processed' => 1,
            'not_processed' => 0,
        )
    );
}

/**
 * Re cache spider names.
 *
 * @package SearchEngines
 */
function recacheSpiderNames()
{
    $db = database();

    $request = $db->query('', '
        SELECT id_spider, spider_name
        FROM {db_prefix}spiders',
        array(
        )
    );
    $spiders = array();
    while ($row = $db->fetch_assoc($request))
        $spiders[$row['id_spider']] = $row['spider_name'];
    $db->free_result($request);

    updateSettings(array('spider_name_cache' => serialize($spiders)));
}

/**
 * Sort the search engine table by user agent name to avoid misidentifying of engine.
 *
 * @package SearchEngines
 * @deprecated since 1.0 - the ordering is done in the query, probably not needed
 */
function sortSpiderTable()
{
    $db = database();

    $db->skip_next_error();
    // Order the table by user_agent length.
    $db->query('alter_table', '
        ALTER TABLE {db_prefix}spiders
        ORDER BY LENGTH(user_agent) DESC',
        array()
    );
}

/**
 * Return spiders, within the limits specified by parameters
 * (used by createList() callbacks)
 *
 * @package SearchEngines
 * @param int $start The item to start with (for pagination purposes)
 * @param int $items_per_page  The number of items to show per page
 * @param string $sort A string indicating how to sort the results
 */
function getSpiders($start, $items_per_page, $sort)
{
    $db = database();

    $request = $db->query('', '
        SELECT id_spider, spider_name, user_agent, ip_info
        FROM {db_prefix}spiders
        ORDER BY {raw:sort}
        LIMIT {int:start}, {int:limit}',
        array(
            'sort' => $sort,
            'start' => $start,
            'limit' => $items_per_page,
        )
    );
    $spiders = array();
    while ($row = $db->fetch_assoc($request))
        $spiders[$row['id_spider']] = $row;
    $db->free_result($request);

    return $spiders;
}

/**
 * Return details of one spider from its ID
 *
 * @package SearchEngines
 * @param int $spider_id id of a spider
 */
function getSpiderDetails($spider_id)
{
    $db = database();

    $request = $db->query('', '
        SELECT id_spider as id, spider_name as name, user_agent as agent, ip_info
        FROM {db_prefix}spiders
        WHERE id_spider = {int:current_spider}',
        array(
            'current_spider' => $spider_id,
        )
    );
    $spider = $db->fetch_assoc($request);

    $db->free_result($request);

    return $spider;
}

/**
 * Return the registered spiders count.
 * (used by createList() callbacks)
 *
 * @package SearchEngines
 * @return int
 */
function getNumSpiders()
{
    $db = database();

    $request = $db->query('', '
        SELECT COUNT(*) AS num_spiders
        FROM {db_prefix}spiders',
        array(
        )
    );
    list ($numSpiders) = $db->fetch_row($request);
    $db->free_result($request);

    return $numSpiders;
}

/**
 * Retrieve spider logs within the specified limits.
 *
 * - (used by createList() callbacks)
 *
 * @package SearchEngines
 * @param int $start The item to start with (for pagination purposes)
 * @param int $items_per_page The number of items to show per page
 * @param string $sort A string indicating how to sort the results
 * @return array An array of spider hits
 */
function getSpiderLogs($start, $items_per_page, $sort)
{
    $db = database();

    $request = $db->query('', '
        SELECT sl.id_spider, sl.url, sl.log_time, s.spider_name
        FROM {db_prefix}log_spider_hits AS sl
            INNER JOIN {db_prefix}spiders AS s ON (s.id_spider = sl.id_spider)
        ORDER BY ' . $sort . '
        LIMIT ' . $start . ', ' . $items_per_page,
        array(
        )
    );
    $spider_logs = array();
    while ($row = $db->fetch_assoc($request))
        $spider_logs[] = $row;
    $db->free_result($request);

    return $spider_logs;
}

/**
 * Returns the count of spider logs.
 * (used by createList() callbacks)
 *
 * @package SearchEngines
 * @return int The number of rows in the log_spider_hits table
 */
function getNumSpiderLogs()
{
    $db = database();

    $request = $db->query('', '
        SELECT COUNT(*) AS num_logs
        FROM {db_prefix}log_spider_hits',
        array(
        )
    );
    list ($numLogs) = $db->fetch_row($request);
    $db->free_result($request);

    return $numLogs;
}

/**
 * Get a list of spider stats from the log_spider table within the specified
 * limits.
 * (used by createList() callbacks)
 *
 * @package SearchEngines
 * @param int $start The item to start with (for pagination purposes)
 * @param int $items_per_page The number of items to show per page
 * @param string $sort A string indicating how to sort the results
 */
function getSpiderStats($start, $items_per_page, $sort)
{
    $db = database();

    $request = $db->query('', '
        SELECT ss.id_spider, ss.stat_date, ss.page_hits, s.spider_name
        FROM {db_prefix}log_spider_stats AS ss
            INNER JOIN {db_prefix}spiders AS s ON (s.id_spider = ss.id_spider)
        ORDER BY ' . $sort . '
        LIMIT ' . $start . ', ' . $items_per_page,
        array(
        )
    );
    $spider_stats = array();
    while ($row = $db->fetch_assoc($request))
        $spider_stats[] = $row;
    $db->free_result($request);

    return $spider_stats;
}

/**
 * Get the number of spider stat rows from the log spider stats table
 * (used by createList() callbacks)
 *
 * @package SearchEngines
 * @param int|null $time (optional) if specified counts only the entries before that date
 * @return int The number of rows in the log_spider_stats table
 */
function getNumSpiderStats($time = null)
{
    $db = database();

    $request = $db->query('', '
        SELECT COUNT(*)
        FROM {db_prefix}log_spider_stats' . ($time === null ? '' : '
        WHERE stat_date < {date:date_being_viewed}'),
        array(
            'date_being_viewed' => $time,
        )
    );
    list ($numStats) = $db->fetch_row($request);
    $db->free_result($request);

    return $numStats;
}

/**
 * Remove spider logs older than the passed time
 *
 * @package SearchEngines
 * @param int $time a time value
 */
function removeSpiderOldLogs($time)
{
    $db = database();

    // Delete the entries.
    $db->query('', '
        DELETE FROM {db_prefix}log_spider_hits
        WHERE log_time < {int:delete_period}',
        array(
            'delete_period' => $time,
        )
    );
}

/**
 * Remove spider logs older than the passed time
 *
 * @package SearchEngines
 * @param int $time a time value
 */
function removeSpiderOldStats($time)
{
    $db = database();

    // Delete the entries.
    $db->query('', '
        DELETE FROM {db_prefix}log_spider_stats
        WHERE last_seen < {int:delete_period}',
        array(
            'delete_period' => $time,
        )
    );
}

/**
 * Remove all the entries connected to a certain spider (description, entries, stats)
 *
 * @package SearchEngines
 * @param int[] $spiders_id an array of spider ids
 */
function removeSpiders($spiders_id)
{
    $db = database();

    $db->query('', '
        DELETE FROM {db_prefix}spiders
        WHERE id_spider IN ({array_int:remove_list})',
        array(
            'remove_list' => $spiders_id,
        )
    );
    $db->query('', '
        DELETE FROM {db_prefix}log_spider_hits
        WHERE id_spider IN ({array_int:remove_list})',
        array(
            'remove_list' => $spiders_id,
        )
    );
    $db->query('', '
        DELETE FROM {db_prefix}log_spider_stats
        WHERE id_spider IN ({array_int:remove_list})',
        array(
            'remove_list' => $spiders_id,
        )
    );
}

/**
 * Returns the last time any spider was seen around
 *
 * @package SearchEngines
 */
function spidersLastSeen()
{
    $db = database();

    $request = $db->query('', '
        SELECT id_spider, MAX(last_seen) AS last_seen_time
        FROM {db_prefix}log_spider_stats
        GROUP BY id_spider',
        array(
        )
    );

    $spider_last_seen = array();
    while ($row = $db->fetch_assoc($request))
        $spider_last_seen[$row['id_spider']] = $row['last_seen_time'];
    $db->free_result($request);

    return $spider_last_seen;
}

/**
 * Returns an array of dates ranging from the first appearance of a spider and the last
 *
 * @package SearchEngines
 */
function spidersStatsDates()
{
    global $txt;

    $db = database();

    // Get the earliest and latest dates.
    $request = $db->query('', '
        SELECT MIN(stat_date) AS first_date, MAX(stat_date) AS last_date
        FROM {db_prefix}log_spider_stats',
        array(
        )
    );

    list ($min_date, $max_date) = $db->fetch_row($request);
    $db->free_result($request);

    $min_year = (int) substr($min_date, 0, 4);
    $max_year = (int) substr($max_date, 0, 4);
    $min_month = (int) substr($min_date, 5, 2);
    $max_month = (int) substr($max_date, 5, 2);

    // Prepare the dates for the drop down.
    $date_choices = array();
    for ($y = $min_year; $y <= $max_year; $y++)
        for ($m = 1; $m <= 12; $m++)
        {
            // This doesn't count?
            if ($y == $min_year && $m < $min_month)
                continue;
            if ($y == $max_year && $m > $max_month)
                break;

            $date_choices[$y . $m] = $txt['months_short'][$m] . ' ' . $y;
        }

    return $date_choices;
}

/**
 * Update an existing or inserts a new spider entry
 *
 * @package SearchEngines
 * @param int $id
 * @param string $name spider name
 * @param string $agent ua of the spider
 * @param string $info_ip
 */
function updateSpider($id = 0, $name = '', $agent = '', $info_ip = '')
{
    $db = database();

    // New spider, insert
    if (empty($id))
        $db->insert('insert',
            '{db_prefix}spiders',
            array(
                'spider_name' => 'string', 'user_agent' => 'string', 'ip_info' => 'string',
            ),
            array(
                $name, $agent, $info_ip,
            ),
            array('id_spider')
        );
    // Existing spider update
    else
        $db->query('', '
            UPDATE {db_prefix}spiders
            SET spider_name = {string:spider_name}, user_agent = {string:spider_agent},
                ip_info = {string:ip_info}
            WHERE id_spider = {int:current_spider}',
            array(
                'current_spider' => $id,
                'spider_name' => $name,
                'spider_agent' => $agent,
                'ip_info' => $info_ip,
            )
        );
}

Namespaces

Classes

Interfaces

Exceptions

Functions