From c4040303cecc48aed66d0102de6b9f5ffdc64b22 Mon Sep 17 00:00:00 2001
From: Evan Prodromou <evan@controlyourself.ca>
Date: Thu, 16 Apr 2009 10:18:16 -0400
Subject: [PATCH] initial snapshot stuff

---
 lib/common.php   |   3 ++
 lib/snapshot.php | 101 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 104 insertions(+)
 create mode 100644 lib/snapshot.php

diff --git a/lib/common.php b/lib/common.php
index dd2570e751..f81c3dc76d 100644
--- a/lib/common.php
+++ b/lib/common.php
@@ -157,6 +157,9 @@ $config =
         'newuser' =>
         array('subscribe' => null,
               'welcome' => null),
+        'snapshot' =>
+        array('run' => 'web',
+              'frequency' => 10000),
         );
 
 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
diff --git a/lib/snapshot.php b/lib/snapshot.php
new file mode 100644
index 0000000000..4f9bb3f62e
--- /dev/null
+++ b/lib/snapshot.php
@@ -0,0 +1,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.");
+        }
+    }
+}