From cd48b89f3166e7fa732b5cb06d33fba018af9127 Mon Sep 17 00:00:00 2001
From: Bharat Mediratta <bharat@menalto.com>
Date: Wed, 15 Dec 2010 14:57:00 -0800
Subject: Consolidate all the random code into a random helper that offers:  
 random::hash()   random::string()   random::percent()   random::int()

So that we don't have lots of different ways to get random values all
over the code.  Follow-on to #1527.
---
 modules/gallery/controllers/upgrader.php         |  2 +-
 modules/gallery/helpers/access.php               |  2 +-
 modules/gallery/helpers/block_manager.php        |  2 +-
 modules/gallery/helpers/gallery_installer.php    |  4 +-
 modules/gallery/helpers/item.php                 |  2 +-
 modules/gallery/helpers/random.php               | 50 ++++++++++++++++++++++++
 modules/gallery/models/item.php                  |  6 +--
 modules/gallery/tests/Albums_Controller_Test.php |  2 +-
 modules/gallery/tests/Cache_Test.php             | 30 +++++++-------
 modules/gallery/tests/Item_Helper_Test.php       |  2 +-
 modules/gallery/tests/Item_Model_Test.php        | 14 +++----
 11 files changed, 83 insertions(+), 33 deletions(-)
 create mode 100644 modules/gallery/helpers/random.php

(limited to 'modules/gallery')

diff --git a/modules/gallery/controllers/upgrader.php b/modules/gallery/controllers/upgrader.php
index 50f6b8f0..66c71648 100644
--- a/modules/gallery/controllers/upgrader.php
+++ b/modules/gallery/controllers/upgrader.php
@@ -23,7 +23,7 @@ class Upgrader_Controller extends Controller {
 
     // Make sure we have an upgrade token
     if (!($upgrade_token = $session->get("upgrade_token", null))) {
-      $session->set("upgrade_token", $upgrade_token = md5(time() . mt_rand()));
+      $session->set("upgrade_token", $upgrade_token = random::hash());
     }
 
     // If the upgrade token exists, then bless this session
diff --git a/modules/gallery/helpers/access.php b/modules/gallery/helpers/access.php
index 6a948999..a7ac3f9f 100644
--- a/modules/gallery/helpers/access.php
+++ b/modules/gallery/helpers/access.php
@@ -426,7 +426,7 @@ class access_Core {
     $session = Session::instance();
     $csrf = $session->get("csrf");
     if (empty($csrf)) {
-      $csrf = md5(time() . mt_rand());
+      $csrf = random::hash();
       $session->set("csrf", $csrf);
     }
     return $csrf;
diff --git a/modules/gallery/helpers/block_manager.php b/modules/gallery/helpers/block_manager.php
index e7247edc..4bd649c2 100644
--- a/modules/gallery/helpers/block_manager.php
+++ b/modules/gallery/helpers/block_manager.php
@@ -28,7 +28,7 @@ class block_manager_Core {
 
   static function add($location, $module_name, $block_id) {
     $blocks = block_manager::get_active($location);
-    $blocks[mt_rand()] = array($module_name, $block_id);
+    $blocks[random::int()] = array($module_name, $block_id);
 
     block_manager::set_active($location, $blocks);
   }
diff --git a/modules/gallery/helpers/gallery_installer.php b/modules/gallery/helpers/gallery_installer.php
index 9c42caad..a6b8e6a2 100644
--- a/modules/gallery/helpers/gallery_installer.php
+++ b/modules/gallery/helpers/gallery_installer.php
@@ -459,7 +459,7 @@ class gallery_installer {
         $blocks = block_manager::get_active($location);
         $new_blocks = array();
         foreach ($blocks as $block) {
-          $new_blocks[mt_rand()] = $block;
+          $new_blocks[random::int()] = $block;
         }
         block_manager::set_active($location, $new_blocks);
       }
@@ -507,7 +507,7 @@ class gallery_installer {
                ->execute() as $row) {
         $new_slug = item::convert_filename_to_slug($row->slug);
         if (empty($new_slug)) {
-          $new_slug = mt_rand();
+          $new_slug = random::int();
         }
         db::build()
           ->update("items")
diff --git a/modules/gallery/helpers/item.php b/modules/gallery/helpers/item.php
index 052b1c8e..664da812 100644
--- a/modules/gallery/helpers/item.php
+++ b/modules/gallery/helpers/item.php
@@ -232,7 +232,7 @@ class item_Core {
     // distributed so this is going to be more efficient with larger data sets.
     return ORM::factory("item")
       ->viewable()
-      ->where("rand_key", "<", ((float)mt_rand()) / (float)mt_getrandmax())
+      ->where("rand_key", "<", random::percent())
       ->order_by("rand_key", "DESC");
   }
 }
\ No newline at end of file
diff --git a/modules/gallery/helpers/random.php b/modules/gallery/helpers/random.php
new file mode 100644
index 00000000..a26762bd
--- /dev/null
+++ b/modules/gallery/helpers/random.php
@@ -0,0 +1,50 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2010 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+class random_Core {
+  /**
+   * Return a random 32 bit hash value.
+   * @param string extra entropy data
+   */
+  static function hash($entropy="") {
+    return md5($entropy . uniqid(mt_rand(), true));
+  }
+
+  /**
+   * Return a random hexadecimal string of the given length.
+   * @param int the desired length of the string
+   */
+  static function string($length) {
+    return substr(random::hash(), 0, $length);
+  }
+
+  /**
+   * Return a random floating point number between 0 and 1
+   */
+  static function percent() {
+    return ((float)mt_rand()) / (float)mt_getrandmax();
+  }
+
+  /**
+   * Return a random number between 0 and mt_getrandmax()
+   */
+  static function int() {
+    return mt_rand();
+  }
+}
\ No newline at end of file
diff --git a/modules/gallery/models/item.php b/modules/gallery/models/item.php
index b6713fc3..ad577066 100644
--- a/modules/gallery/models/item.php
+++ b/modules/gallery/models/item.php
@@ -28,7 +28,7 @@ class Item_Model_Core extends ORM_MPTT {
     if (!$this->loaded()) {
       // Set reasonable defaults
       $this->created = time();
-      $this->rand_key = ((float)mt_rand()) / (float)mt_getrandmax();
+      $this->rand_key = random::percent();
       $this->thumb_dirty = 1;
       $this->resize_dirty = 1;
       $this->sort_column = "created";
@@ -390,7 +390,7 @@ class Item_Model_Core extends ORM_MPTT {
           if (file_exists($this->resize_path()) ||
               file_exists($this->thumb_path())) {
             $pi = pathinfo($this->name);
-            $this->name = $pi["filename"] . "-" . mt_rand() . "." . $pi["extension"];
+            $this->name = $pi["filename"] . "-" . random::int() . "." . $pi["extension"];
             parent::save();
           }
 
@@ -512,7 +512,7 @@ class Item_Model_Core extends ORM_MPTT {
            ->or_where("slug", "=", $this->slug)
            ->close()
            ->find()->id) {
-      $rand = mt_rand();
+      $rand = random::int();
       if ($base_ext) {
         $this->name = "$base_name-$rand.$base_ext";
       } else {
diff --git a/modules/gallery/tests/Albums_Controller_Test.php b/modules/gallery/tests/Albums_Controller_Test.php
index 86c74890..35a3bdbb 100644
--- a/modules/gallery/tests/Albums_Controller_Test.php
+++ b/modules/gallery/tests/Albums_Controller_Test.php
@@ -31,7 +31,7 @@ class Albums_Controller_Test extends Gallery_Unit_Test_Case {
     $album = test::random_album();
 
     // Randomize to avoid conflicts.
-    $new_name = "new_name_" . mt_rand();
+    $new_name = "new_name_" . random::string(6);
 
     $_POST["name"] = $new_name;
     $_POST["title"] = "new title";
diff --git a/modules/gallery/tests/Cache_Test.php b/modules/gallery/tests/Cache_Test.php
index 6cee2862..b95ef0a2 100644
--- a/modules/gallery/tests/Cache_Test.php
+++ b/modules/gallery/tests/Cache_Test.php
@@ -27,7 +27,7 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   public function cache_exists_test() {
     $this->assert_false($this->_driver->exists("test_key"), "test_key should not be defined");
 
-    $id = md5(mt_rand());
+    $id = random::hash();
     db::build()
       ->insert("caches")
       ->columns("key", "tags", "expiration", "cache")
@@ -38,7 +38,7 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_get_test() {
-    $id = md5(mt_rand());
+    $id = random::hash();
 
     db::build()
       ->insert("caches")
@@ -54,7 +54,7 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_set_test() {
-    $id = md5(mt_rand());
+    $id = random::hash();
     $original_data = array("field1" => "value1", "field2" => "value2");
     $this->_driver->set(array($id => $original_data), array("tag1", "tag2"), 84600);
 
@@ -63,15 +63,15 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_get_tag_test() {
-    $id1 = md5(mt_rand());
+    $id1 = random::hash();
     $value1 = array("field1" => "value1", "field2" => "value2");
     $this->_driver->set(array($id1 => $value1), array("tag1", "tag2"), 84600);
 
-    $id2 = md5(mt_rand());
+    $id2 = random::hash();
     $value2 = array("field3" => "value3", "field4" => "value4");
     $this->_driver->set(array($id2 => $value2), array("tag2", "tag3"), 84600);
 
-    $id3 = md5(mt_rand());
+    $id3 = random::hash();
     $value3 = array("field5" => "value5", "field6" => "value6");
     $this->_driver->set(array($id3 => $value3), array("tag3", "tag4"), 84600);
 
@@ -86,15 +86,15 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_delete_id_test() {
-    $id1 = md5(mt_rand());
+    $id1 = random::hash();
     $value1 = array("field1" => "value1", "field2" => "value2");
     $this->_driver->set(array($id1 => $value1), array("tag1", "tag2"), 84600);
 
-    $id2 = md5(mt_rand());
+    $id2 = random::hash();
     $value2 = array("field3" => "value3", "field4" => "value4");
     $this->_driver->set(array($id2 => $value2), array("tag2", "tag3"), 846000);
 
-    $id3 = md5(mt_rand());
+    $id3 = random::hash();
     $value3 = array("field5" => "value5", "field6" => "value6");
     $this->_driver->set(array($id3 => $value3), array("tag3", "tag4"), 84600);
 
@@ -106,15 +106,15 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_delete_tag_test() {
-    $id1 = md5(mt_rand());
+    $id1 = random::hash();
     $value1 = array("field1" => "value1", "field2" => "value2");
     $this->_driver->set(array($id1 => $value1), array("tag1", "tag2"), 84600);
 
-    $id2 = md5(mt_rand());
+    $id2 = random::hash();
     $value2 = array("field3" => "value3", "field4" => "value4");
     $this->_driver->set(array($id2 => $value2), array("tag2", "tag3"), 846000);
 
-    $id3 = md5(mt_rand());
+    $id3 = random::hash();
     $value3 = array("field5" => "value5", "field6" => "value6");
     $this->_driver->set(array($id3 => $value3), array("tag3", "tag4"), 84600);
 
@@ -126,15 +126,15 @@ class Cache_Test extends Gallery_Unit_Test_Case {
   }
 
   public function cache_delete_all_test() {
-    $id1 = md5(mt_rand());
+    $id1 = random::hash();
     $value1 = array("field1" => "value1", "field2" => "value2");
     $this->_driver->set(array($id1 => $value1), array("tag1", "tag2"), 84600);
 
-    $id2 = md5(mt_rand());
+    $id2 = random::hash();
     $value2 = array("field3" => "value3", "field4" => "value4");
     $this->_driver->set(array($id2 => $value2), array("tag2", "tag3"), 846000);
 
-    $id3 = md5(mt_rand());
+    $id3 = random::hash();
     $value3 = array("field5" => "value5", "field6" => "value6");
     $this->_driver->set(array($id3 => $value3), array("tag3", "tag4"), 84600);
 
diff --git a/modules/gallery/tests/Item_Helper_Test.php b/modules/gallery/tests/Item_Helper_Test.php
index c93cc239..26db5a63 100644
--- a/modules/gallery/tests/Item_Helper_Test.php
+++ b/modules/gallery/tests/Item_Helper_Test.php
@@ -92,7 +92,7 @@ class Item_Helper_Test extends Gallery_Unit_Test_Case {
   }
 
   public function move_conflicts_result_in_a_rename_test() {
-    $rand = mt_rand();
+    $rand = random::int();
     $photo1 = test::random_photo_unsaved(item::root());
     $photo1->name = "{$rand}.jpg";
     $photo1->slug = (string)$rand;
diff --git a/modules/gallery/tests/Item_Model_Test.php b/modules/gallery/tests/Item_Model_Test.php
index 0d6d10af..4987d2f9 100644
--- a/modules/gallery/tests/Item_Model_Test.php
+++ b/modules/gallery/tests/Item_Model_Test.php
@@ -278,10 +278,10 @@ class Item_Model_Test extends Gallery_Unit_Test_Case {
 
   public function basic_validation_test() {
     $item = ORM::factory("item");
-    $item->album_cover_item_id = mt_rand();  // invalid
+    $item->album_cover_item_id = random::int();  // invalid
     $item->description = str_repeat("x", 70000);  // invalid
     $item->name = null;
-    $item->parent_id = mt_rand();
+    $item->parent_id = random::int();
     $item->slug = null;
     $item->sort_column = "bogus";
     $item->sort_order = "bogus";
@@ -411,24 +411,24 @@ class Item_Model_Test extends Gallery_Unit_Test_Case {
   public function urls_test() {
     $photo = test::random_photo();
     $this->assert_true(
-      preg_match("|http://./var/resizes/name_\d+\.jpg\?m=\d+|", $photo->resize_url()),
+      preg_match("|http://./var/resizes/name_\w+\.jpg\?m=\d+|", $photo->resize_url()),
       $photo->resize_url() . " is malformed");
     $this->assert_true(
-      preg_match("|http://./var/thumbs/name_\d+\.jpg\?m=\d+|", $photo->thumb_url()),
+      preg_match("|http://./var/thumbs/name_\w+\.jpg\?m=\d+|", $photo->thumb_url()),
       $photo->thumb_url() . " is malformed");
     $this->assert_true(
-      preg_match("|http://./var/albums/name_\d+\.jpg\?m=\d+|", $photo->file_url()),
+      preg_match("|http://./var/albums/name_\w+\.jpg\?m=\d+|", $photo->file_url()),
       $photo->file_url() . " is malformed");
 
     // Albums have special thumbnails.  Empty album has cachebuster of 0 since it has no thumbnail
     $album = test::random_album();
     $this->assert_true(
-      preg_match("|http://./var/thumbs/name_\d+/\.album\.jpg\?m=0|", $album->thumb_url()),
+      preg_match("|http://./var/thumbs/name_\w+/\.album\.jpg\?m=0|", $album->thumb_url()),
       $album->thumb_url() . " is malformed");
 
     $photo = test::random_photo($album);
     $this->assert_true(
-      preg_match("|http://./var/thumbs/name_\d+/\.album\.jpg\?m=\d+|", $album->thumb_url()),
+      preg_match("|http://./var/thumbs/name_\w+/\.album\.jpg\?m=\d+|", $album->thumb_url()),
       $album->thumb_url() . " is malformed");
   }
 
-- 
cgit v1.2.3