scripts/createsim.php

   1 #!/usr/bin/env php
   2 <?php
   3 /*
   4  * StatusNet - the distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, StatusNet, Inc.
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  22
  23 $shortoptions = 'b:g:j:n:t:u:w:x:z:';
  24 $longoptions = array(
  25     'subscriptions=',
  26     'groups=',
  27     'joins=',
  28     'notices=',
  29     'tags=',
  30     'users=',
  31     'words=',
  32     'prefix=',
  33     'groupprefix=',
  34 //    'faves=',
  35 );
  36
  37 $helptext = <<<END_OF_CREATESIM_HELP
  38 Creates a lot of test users and notices to (loosely) simulate a real server.
  39
  40     -b --subscriptions Average subscriptions per user (default no. users/20)
  41     -g --groups        Number of groups (default 20)
  42     -j --joins         Number of groups per user (default 5)
  43     -n --notices       Average notices per user (default 100)
  44     -t --tags          Number of distinct hash tags (default 10000)
  45     -u --users         Number of users (default 100)
  46     -w --words         Words file (default '/usr/share/dict/words')
  47     -x --prefix        User name prefix (default 'testuser')
  48     -z --groupprefix   Group name prefix (default 'testgroup')
  49
  50 END_OF_CREATESIM_HELP;
  51
  52 require_once INSTALLDIR.'/scripts/commandline.inc.php';
  53
  54 // XXX: make these command-line options
  55
  56 function newUser($i)
  57 {
  58     global $userprefix;
  59     $user = User::register(array('nickname' => sprintf('%s%d', $userprefix, $i),
  60                                  'password' => sprintf('password%d', $i),
  61                                  'fullname' => sprintf('Test User %d', $i)));
  62     if (!empty($user)) {
  63         $user->free();
  64     }
  65 }
  66
  67 function newGroup($i, $j)
  68 {
  69     global $groupprefix;
  70     global $userprefix;
  71
  72     // Pick a random user to be the admin
  73
  74     $n = rand(0, max($j - 1, 0));
  75     $user = User::getKV('nickname', sprintf('%s%d', $userprefix, $n));
  76
  77     $group = User_group::register(array('nickname' => sprintf('%s%d', $groupprefix, $i),
  78                                         'local'    => true,
  79                                         'userid'   => $user->id,
  80                                         'fullname' => sprintf('Test Group %d', $i)));
  81 }
  82
  83 function newNotice($i, $tagmax)
  84 {
  85     global $userprefix;
  86
  87     $options = array('scope' => Notice::defaultScope());
  88
  89     $n = rand(0, $i - 1);
  90     $user = User::getKV('nickname', sprintf('%s%d', $userprefix, $n));
  91
  92     $is_reply = rand(0, 1);
  93
  94     $content = testNoticeContent();
  95
  96     if ($is_reply == 0) {
  97         $stream = new InboxNoticeStream($user->getProfile(), $user->getProfile());
  98         $notices = $stream->getNotices(0, 20);
  99         if ($notices->N > 0) {
 100             $nval = rand(0, $notices->N - 1);
 101             $notices->fetch(); // go to 0th
 102             for ($i = 0; $i < $nval; $i++) {
 103                 $notices->fetch();
 104             }
 105             $options['reply_to'] = $notices->id;
 106             $dont_use_nickname = rand(0, 2);
 107             if ($dont_use_nickname != 0) {
 108                 $rprofile = $notices->getProfile();
 109                 $content = "@".$rprofile->nickname." ".$content;
 110             }
 111             $private_to_addressees = rand(0, 4);
 112             if ($private_to_addressees == 0) {
 113                 $options['scope'] |= Notice::ADDRESSEE_SCOPE;
 114             }
 115         }
 116     } else {
 117         $is_directed = rand(0, 4);
 118
 119         if ($is_directed == 0) {
 120             $subs = $user->getSubscribed(0, 100)->fetchAll();
 121             if (count($subs) > 0) {
 122                 $seen = array();
 123                 $f = rand(0, 9);
 124                 if ($f <= 6) {
 125                     $addrs = 1;
 126                 } else if ($f <= 8) {
 127                     $addrs = 2;
 128                 } else {
 129                     $addrs = 3;
 130                 }
 131                 for ($m = 0; $m < $addrs; $m++) {
 132                     $x = rand(0, count($subs) - 1);
 133                     if ($seen[$x]) {
 134                         continue;
 135                     }
 136                     if ($subs[$x]->id == $user->id) {
 137                         continue;
 138                     }
 139                     $seen[$x] = true;
 140                     $rprofile = $subs[$x];
 141                     $content = "@".$rprofile->nickname." ".$content;
 142                 }
 143                 $private_to_addressees = rand(0, 4);
 144                 if ($private_to_addressees == 0) {
 145                     $options['scope'] |= Notice::ADDRESSEE_SCOPE;
 146                 }
 147             }
 148         }
 149     }
 150
 151     $has_hash = rand(0, 2);
 152
 153     if ($has_hash == 0) {
 154         $hashcount = rand(0, 2);
 155         for ($j = 0; $j < $hashcount; $j++) {
 156             $h = rand(0, $tagmax);
 157             $content .= " #tag{$h}";
 158         }
 159     }
 160
 161     $in_group = rand(0, 5);
 162
 163     if ($in_group == 0) {
 164         $groups = $user->getGroups();
 165         if ($groups instanceof User_group) {
 166             $gval = rand(0, $groups->N - 1);
 167             $groups->fetch(); // go to 0th
 168             for ($i = 0; $i < $gval; $i++) {
 169                 $groups->fetch();
 170             }
 171             $options['groups'] = array($groups->id);
 172             $content = "!".$groups->nickname." ".$content;
 173             $private_to_group = rand(0, 2);
 174             if ($private_to_group == 0) {
 175                 $options['scope'] |= Notice::GROUP_SCOPE;
 176             }
 177         }
 178     }
 179
 180     $private_to_site = rand(0, 4);
 181
 182     if ($private_to_site == 0) {
 183         $options['scope'] |= Notice::SITE_SCOPE;
 184     }
 185
 186     $notice = Notice::saveNew($user->id, $content, 'createsim', $options);
 187 }
 188
 189 function newMessage($i)
 190 {
 191     global $userprefix;
 192
 193     $n = rand(0, $i - 1);
 194     $user = User::getKV('nickname', sprintf('%s%d', $userprefix, $n));
 195
 196     $content = testNoticeContent();
 197
 198     $friends = $user->mutuallySubscribedUsers()->fetchAll();
 199
 200     if (count($friends) == 0) {
 201         return;
 202     }
 203
 204     $j = rand(0, count($friends) - 1);
 205
 206     $other = $friends[$j];
 207
 208     $message = Message::saveNew($user->id, $other->id, $content, 'createsim');
 209 }
 210
 211 function newSub($i)
 212 {
 213     global $userprefix;
 214     $f = rand(0, $i - 1);
 215
 216     $fromnick = sprintf('%s%d', $userprefix, $f);
 217
 218     $from = User::getKV('nickname', $fromnick);
 219
 220     if (empty($from)) {
 221         throw new Exception("Can't find user '$fromnick'.");
 222     }
 223
 224     $t = rand(0, $i - 1);
 225
 226     if ($t == $f) {
 227         $t++;
 228         if ($t > $i - 1) {
 229             $t = 0;
 230         }
 231     }
 232
 233     $tunic = sprintf('%s%d', $userprefix, $t);
 234
 235     $to = User::getKV('nickname', $tunic);
 236
 237     if (!($to instanceof User)) {
 238         throw new Exception("Can't find user '$tunic'.");
 239     }
 240
 241     Subscription::start($from->getProfile(), $to->getProfile());
 242
 243     $from->free();
 244     $to->free();
 245 }
 246
 247 function newJoin($u, $g)
 248 {
 249     global $userprefix;
 250     global $groupprefix;
 251
 252     $userNumber = rand(0, $u - 1);
 253
 254     $userNick = sprintf('%s%d', $userprefix, $userNumber);
 255
 256     $user = User::getKV('nickname', $userNick);
 257
 258     if (empty($user)) {
 259         throw new Exception("Can't find user '$fromnick'.");
 260     }
 261
 262     $groupNumber = rand(0, $g - 1);
 263
 264     $groupNick = sprintf('%s%d', $groupprefix, $groupNumber);
 265
 266     $group = User_group::getKV('nickname', $groupNick);
 267
 268     if (empty($group)) {
 269         throw new Exception("Can't find group '$groupNick'.");
 270     }
 271
 272     if (!$user->isMember($group)) {
 273         $user->joinGroup($group);
 274     }
 275 }
 276
 277 /* Plugins should be part of the simulation too!
 278 function newFave($u)
 279 {
 280     global $userprefix;
 281     global $groupprefix;
 282
 283     $userNumber = rand(0, $u - 1);
 284
 285     $userNick = sprintf('%s%d', $userprefix, $userNumber);
 286
 287     $user = User::getKV('nickname', $userNick);
 288
 289     if (empty($user)) {
 290         throw new Exception("Can't find user '$userNick'.");
 291     }
 292
 293     // NB: it's OK to like your own stuff!
 294
 295     $otherNumber = rand(0, $u - 1);
 296
 297     $otherNick = sprintf('%s%d', $userprefix, $otherNumber);
 298
 299     $other = User::getKV('nickname', $otherNick);
 300
 301     if (empty($other)) {
 302         throw new Exception("Can't find user '$otherNick'.");
 303     }
 304
 305     $notices = $other->getNotices()->fetchAll();
 306
 307     if (count($notices) == 0) {
 308         return;
 309     }
 310
 311     $idx = rand(0, count($notices) - 1);
 312
 313     $notice = $notices[$idx];
 314
 315     if ($user->hasFave($notice)) {
 316         return;
 317     }
 318
 319     Fave::addNew($user->getProfile(), $notice);
 320 }*/
 321
 322 function testNoticeContent()
 323 {
 324     global $words;
 325
 326     if (is_null($words)) {
 327         return "test notice content";
 328     }
 329
 330     $cnt = rand(3, 8);
 331
 332     $ids = array_rand($words, $cnt);
 333
 334     foreach ($ids as $id) {
 335         $parts[] = $words[$id];
 336     }
 337
 338     $text = implode(' ', $parts);
 339
 340     if (mb_strlen($text) > 80) {
 341         $text = substr($text, 0, 77) . "...";
 342     }
 343
 344     return $text;
 345 }
 346
 347 //function main($usercount, $groupcount, $noticeavg, $subsavg, $joinsavg, $favesavg, $messageavg, $tagmax)
 348 function main($usercount, $groupcount, $noticeavg, $subsavg, $joinsavg, $messageavg, $tagmax)
 349 {
 350     global $config;
 351     $config['site']['dupelimit'] = -1;
 352
 353     $n = 0;
 354     $g = 0;
 355
 356     // Make users first
 357
 358     $preuser = min($usercount, 5);
 359
 360     for ($j = 0; $j < $preuser; $j++) {
 361         printfv("$i Creating user $n\n");
 362         newUser($n);
 363         $n++;
 364     }
 365
 366     $pregroup = min($groupcount, 3);
 367
 368     for ($k = 0; $k < $pregroup; $k++) {
 369         printfv("$i Creating group $g\n");
 370         newGroup($g, $n);
 371         $g++;
 372     }
 373
 374     // # registrations + # notices + # subs
 375
 376     //$events = $usercount + $groupcount + ($usercount * ($noticeavg + $subsavg + $joinsavg + $favesavg + $messageavg));
 377     $events = $usercount + $groupcount + ($usercount * ($noticeavg + $subsavg + $joinsavg + $messageavg));
 378
 379     $events -= $preuser;
 380     $events -= $pregroup;
 381
 382     $ut = $usercount;
 383     $gt = $ut + $groupcount;
 384     $nt = $gt + ($usercount * $noticeavg);
 385     $st = $nt + ($usercount * $subsavg);
 386     $jt = $st + ($usercount * $joinsavg);
 387 //    $ft = $jt + ($usercount * $favesavg);
 388     $mt = $ft + ($usercount * $messageavg);
 389
 390     printfv("$events events ($ut, $gt, $nt, $st, $jt, $ft, $mt)\n");
 391
 392     for ($i = 0; $i < $events; $i++)
 393     {
 394         $e = rand(0, $events);
 395
 396         if ($e >= 0 && $e <= $ut) {
 397             printfv("$i Creating user $n\n");
 398             newUser($n);
 399             $n++;
 400         } else if ($e > $ut && $e <= $gt) {
 401             printfv("$i Creating group $g\n");
 402             newGroup($g, $n);
 403             $g++;
 404         } else if ($e > $gt && $e <= $nt) {
 405             printfv("$i Making a new notice\n");
 406             newNotice($n, $tagmax);
 407         } else if ($e > $nt && $e <= $st) {
 408             printfv("$i Making a new subscription\n");
 409             newSub($n);
 410         } else if ($e > $st && $e <= $jt) {
 411             printfv("$i Making a new group join\n");
 412             newJoin($n, $g);
 413 /*        } else if ($e > $jt && $e <= $ft) {
 414             printfv("$i Making a new fave\n");
 415             newFave($n);*/
 416         } else if ($e > $ft && $e <= $mt) {
 417             printfv("$i Making a new message\n");
 418             newMessage($n);
 419         } else {
 420             printfv("No event for $i!");
 421         }
 422     }
 423 }
 424
 425 $defaultWordsfile = '/usr/share/dict/words';
 426
 427 $usercount   = (have_option('u', 'users')) ? get_option_value('u', 'users') : 100;
 428 $groupcount  = (have_option('g', 'groups')) ? get_option_value('g', 'groups') : 20;
 429 $noticeavg   = (have_option('n', 'notices')) ? get_option_value('n', 'notices') : 100;
 430 $subsavg     = (have_option('b', 'subscriptions')) ? get_option_value('b', 'subscriptions') : max($usercount/20, 10);
 431 $joinsavg    = (have_option('j', 'joins')) ? get_option_value('j', 'joins') : 5;
 432 //$favesavg    = (have_option('f', 'faves')) ? get_option_value('f', 'faves') : max($noticeavg/10, 5);
 433 $messageavg  = (have_option('m', 'messages')) ? get_option_value('m', 'messages') : max($noticeavg/10, 5);
 434 $tagmax      = (have_option('t', 'tags')) ? get_option_value('t', 'tags') : 10000;
 435 $userprefix  = (have_option('x', 'prefix')) ? get_option_value('x', 'prefix') : 'testuser';
 436 $groupprefix = (have_option('z', 'groupprefix')) ? get_option_value('z', 'groupprefix') : 'testgroup';
 437 $wordsfile   = (have_option('w', 'words')) ? get_option_value('w', 'words') : $defaultWordsfile;
 438
 439 if (is_readable($wordsfile)) {
 440     $words = file($wordsfile);
 441 } else {
 442    if ($wordsfile != $defaultWordsfile) {
 443       // user specified words file couldn't be read
 444       throw new Exception("Couldn't read words file: {$wordsfile}.");
 445     }
 446     $words = null;
 447 }
 448
 449 try {
 450     //main($usercount, $groupcount, $noticeavg, $subsavg, $joinsavg, $favesavg, $messageavg, $tagmax);
 451     main($usercount, $groupcount, $noticeavg, $subsavg, $joinsavg, $messageavg, $tagmax);
 452 } catch (Exception $e) {
 453     printfv("Got an exception: ".$e->getMessage());
 454 }