summaryrefslogtreecommitdiff
path: root/lib/snapshot.php
blob: 4f9bb3f62ec5834588f7ee7e9b75e5f6b19dfacd (plain)
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
<?php
/**
 * Laconica, the distributed open-source microblogging tool
 *
 * A snapshot of site stats that can report itself to headquarters
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Stats
 * @package   Laconica
 * @author    Evan Prodromou <evan@controlyourself.ca>
 * @copyright 2009 Control Yourself, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://laconi.ca/
 */

if (!defined('LACONICA')) {
    exit(1);
}

/**
 * A snapshot of site stats that can report itself to headquarters
 *
 * This class will collect statistics on the site and report them to
 * a statistics server of the admin's choice. (Default is the big one
 * at laconi.ca.)
 *
 * It can either be called from a cron job, or run occasionally by the
 * Web site.
 *
 * @category Stats
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 *
 */

class Snapshot {

    function __construct()
    {
    }

    function take()
    {
    }

    function report()
    {
    }

    static function check()
    {
        switch (common_config('snapshot', 'run')) {
         case 'web':
            // skip if we're not running on the Web.
            if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
                break;
            }
            // Run once every frequency hits
            // XXX: do frequency by time (once a week, etc.) rather than
            // hits
            if (rand() % common_config('snapshot', 'frequency') == 0) {
                $snapshot = new Snapshot();
                if ($snapshot->take()) {
                    $snapshot->report();
                }
            }
            break;
         case 'cron':
            // skip if we're running on the Web
            if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
                break;
            }
            // We're running from the command line; assume
            $snapshot = new Snapshot();
            if ($snapshot->take()) {
                $snapshot->report();
            }
            break;
         case 'never':
            break;
         default:
            common_log(LOG_WARNING, "Unrecognized value for snapshot run config.");
        }
    }
}