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     -f --faves         Number of faves per user (default notices/10)
  44     -n --notices       Average notices per user (default 100)
  45     -t --tags          Number of distinct hash tags (default 10000)
  46     -u --users         Number of users (default 100)
  47     -w --words         Words file (default '/usr/share/dict/words')
  48     -x --prefix        User name prefix (default 'testuser')
  49     -z --groupprefix   Group name prefix (default 'testgroup')
  50
  51 END_OF_CREATESIM_HELP;
  52
  53 require_once INSTALLDIR.'/scripts/commandline.inc';
  54
  55 // XXX: make these command-line options
  56
  57 function newUser($i)
  58 {
  59     global $userprefix;
  60     $user = User::register(array('nickname' => sprintf('%s%d', $userprefix, $i),
  61                                  'password' => sprintf('password%d', $i),
  62                                  'fullname' => sprintf('Test User %d', $i)));
  63     if (!empty($user)) {
  64         $user->free();
  65     }
  66 }
  67
  68 function newGroup($i, $j)
  69 {
  70     global $groupprefix;
  71     global $userprefix;
  72
  73     // Pick a random user to be the admin
  74
  75     $n = rand(0, max($j - 1, 0));
  76     $user = User::staticGet('nickname', sprintf('%s%d', $userprefix, $n));
  77
  78     $group = User_group::register(array('nickname' => sprintf('%s%d', $groupprefix, $i),
  79                                         'local'    => true,
  80                                         'userid'   => $user->id,
  81                                         'fullname' => sprintf('Test Group %d', $i)));
  82 }
  83
  84 function newNotice($i, $tagmax)
  85 {
  86     global $userprefix;
  87
  88     $options = array('scope' => Notice::defaultScope());
  89
  90     $n = rand(0, $i - 1);
  91     $user = User::staticGet('nickname', sprintf('%s%d', $userprefix, $n));
  92
  93     $is_reply = rand(0, 1);
  94
  95     $content = testNoticeContent();
  96
  97     if ($is_reply == 0) {
  98         $stream = new InboxNoticeStream($user, $user->getProfile());
  99         $notices = $stream->getNotices(0, 20);
 100         if ($notices->N > 0) {
 101             $nval = rand(0, $notices->N - 1);
 102             $notices->fetch(); // go to 0th
 103             for ($i = 0; $i < $nval; $i++) {
 104                 $notices->fetch();
 105             }
 106             $options['reply_to'] = $notices->id;
 107             $dont_use_nickname = rand(0, 2);
 108             if ($dont_use_nickname != 0) {
 109                 $rprofile = $notices->getProfile();
 110                 $content = "@".$rprofile->nickname." ".$content;
 111             }
 112             $private_to_addressees = rand(0, 4);
 113             if ($private_to_addressees == 0) {
 114                 $options['scope'] |= Notice::ADDRESSEE_SCOPE;
 115             }
 116         }
 117     } else {
 118         $is_directed = rand(0, 4);
 119
 120         if ($is_directed == 0) {
 121             $subs = $user->getSubscriptions(0, 100)->fetchAll();
 122             if (count($subs) > 0) {
 123                 $seen = array();
 124                 $f = rand(0, 9);
 125                 if ($f <= 6) {
 126                     $addrs = 1;
 127                 } else if ($f <= 8) {
 128                     $addrs = 2;
 129                 } else {
 130                     $addrs = 3;
 131                 }
 132                 for ($m = 0; $m < $addrs; $m++) {
 133                     $x = rand(0, count($subs) - 1);
 134                     if ($seen[$x]) {
 135                         continue;
 136                     }
 137                     if ($subs[$x]->id == $user->id) {
 138                         continue;
 139                     }
 140                     $seen[$x] = true;
 141                     $rprofile = $subs[$x];
 142                     $content = "@".$rprofile->nickname." ".$content;
 143                 }
 144                 $private_to_addressees = rand(0, 4);
 145                 if ($private_to_addressees == 0) {
 146                     $options['scope'] |= Notice::ADDRESSEE_SCOPE;
 147                 }
 148             }
 149         }
 150     }
 151
 152     $has_hash = rand(0, 2);
 153
 154     if ($has_hash == 0) {
 155         $hashcount = rand(0, 2);
 156         for ($j = 0; $j < $hashcount; $j++) {
 157             $h = rand(0, $tagmax);
 158             $content .= " #tag{$h}";
 159         }
 160     }
 161
 162     $in_group = rand(0, 5);
 163
 164     if ($in_group == 0) {
 165         $groups = $user->getGroups();
 166         if ($groups->N > 0) {
 167             $gval = rand(0, $groups->N - 1);
 168             $groups->fetch(); // go to 0th
 169             for ($i = 0; $i < $gval; $i++) {
 170                 $groups->fetch();
 171             }
 172             $options['groups'] = array($groups->id);
 173             $content = "!".$groups->nickname." ".$content;
 174             $private_to_group = rand(0, 2);
 175             if ($private_to_group == 0) {
 176                 $options['scope'] |= Notice::GROUP_SCOPE;
 177             }
 178         }
 179     }
 180
 181     $private_to_site = rand(0, 4);
 182
 183     if ($private_to_site == 0) {
 184         $options['scope'] |= Notice::SITE_SCOPE;
 185     }
 186
 187     $notice = Notice::saveNew($user->id, $content, 'createsim', $options);
 188 }
 189
 190 function newMessage($i)
 191 {
 192     global $userprefix;
 193
 194     $n = rand(0, $i - 1);
 195     $user = User::staticGet('nickname', sprintf('%s%d', $userprefix, $n));
 196
 197     $content = testNoticeContent();
 198
 199     $friends = $user->mutuallySubscribedUsers()->fetchAll();
 200
 201     if (count($friends) == 0) {
 202         return;
 203     }
 204
 205     $j = rand(0, count($friends) - 1);
 206
 207     $other = $friends[$j];
 208
 209     $message = Message::saveNew($user->id, $other->id, $content, 'createsim');
 210 }
 211
 212 function newSub($i)
 213 {
 214     global $userprefix;
 215     $f = rand(0, $i - 1);
 216
 217     $fromnick = sprintf('%s%d', $userprefix, $f);
 218
 219     $from = User::staticGet('nickname', $fromnick);
 220
 221     if (empty($from)) {
 222         throw new Exception("Can't find user '$fromnick'.");
 223     }
 224
 225     $t = rand(0, $i - 1);
 226
 227     if ($t == $f) {
 228         $t++;
 229         if ($t > $i - 1) {
 230             $t = 0;
 231         }
 232     }
 233
 234     $tunic = sprintf('%s%d', $userprefix, $t);
 235
 236     $to = User::staticGet('nickname', $tunic);
 237
 238     if (empty($to)) {
 239         throw new Exception("Can't find user '$tunic'.");
 240     }
 241
 242     subs_subscribe_to($from, $to);
 243
 244     $from->free();
 245     $to->free();
 246 }
 247
 248 function newJoin($u, $g)
 249 {
 250     global $userprefix;
 251     global $groupprefix;
 252
 253     $userNumber = rand(0, $u - 1);
 254
 255     $userNick = sprintf('%s%d', $userprefix, $userNumber);
 256
 257     $user = User::staticGet('nickname', $userNick);
 258
 259     if (empty($user)) {
 260         throw new Exception("Can't find user '$fromnick'.");
 261     }
 262
 263     $groupNumber = rand(0, $g - 1);
 264
 265     $groupNick = sprintf('%s%d', $groupprefix, $groupNumber);
 266
 267     $group = User_group::staticGet('nickname', $groupNick);
 268
 269     if (empty($group)) {
 270         throw new Exception("Can't find group '$groupNick'.");
 271     }
 272
 273     if (!$user->isMember($group)) {
 274         $user->joinGroup($group);
 275     }
 276 }
 277
 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::staticGet('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::staticGet('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 {
 349     global $config;
 350     $config['site']['dupelimit'] = -1;
 351
 352     $n = 0;
 353     $g = 0;
 354
 355     // Make users first
 356
 357     $preuser = min($usercount, 5);
 358
 359     for ($j = 0; $j < $preuser; $j++) {
 360         printfv("$i Creating user $n\n");
 361         newUser($n);
 362         $n++;
 363     }
 364
 365     $pregroup = min($groupcount, 3);
 366
 367     for ($k = 0; $k < $pregroup; $k++) {
 368         printfv("$i Creating group $g\n");
 369         newGroup($g, $n);
 370         $g++;
 371     }
 372
 373     // # registrations + # notices + # subs
 374
 375     $events = $usercount + $groupcount + ($usercount * ($noticeavg + $subsavg + $joinsavg + $favesavg + $messageavg));
 376
 377     $events -= $preuser;
 378     $events -= $pregroup;
 379
 380     $ut = $usercount;
 381     $gt = $ut + $groupcount;
 382     $nt = $gt + ($usercount * $noticeavg);
 383     $st = $nt + ($usercount * $subsavg);
 384     $jt = $st + ($usercount * $joinsavg);
 385     $ft = $jt + ($usercount * $favesavg);
 386     $mt = $ft + ($usercount * $messageavg);
 387
 388     printfv("$events events ($ut, $gt, $nt, $st, $jt, $ft, $mt)\n");
 389
 390     for ($i = 0; $i < $events; $i++)
 391     {
 392         $e = rand(0, $events);
 393
 394         if ($e >= 0 && $e <= $ut) {
 395             printfv("$i Creating user $n\n");
 396             newUser($n);
 397             $n++;
 398         } else if ($e > $ut && $e <= $gt) {
 399             printfv("$i Creating group $g\n");
 400             newGroup($g, $n);
 401             $g++;
 402         } else if ($e > $gt && $e <= $nt) {
 403             printfv("$i Making a new notice\n");
 404             newNotice($n, $tagmax);
 405         } else if ($e > $nt && $e <= $st) {
 406             printfv("$i Making a new subscription\n");
 407             newSub($n);
 408         } else if ($e > $st && $e <= $jt) {
 409             printfv("$i Making a new group join\n");
 410             newJoin($n, $g);
 411         } else if ($e > $jt && $e <= $ft) {
 412             printfv("$i Making a new fave\n");
 413             newFave($n);
 414         } else if ($e > $ft && $e <= $mt) {
 415             printfv("$i Making a new message\n");
 416             newMessage($n);
 417         } else {
 418             printfv("No event for $i!");
 419         }
 420     }
 421 }
 422
 423 $defaultWordsfile = '/usr/share/dict/words';
 424
 425 $usercount   = (have_option('u', 'users')) ? get_option_value('u', 'users') : 100;
 426 $groupcount  = (have_option('g', 'groups')) ? get_option_value('g', 'groups') : 20;
 427 $noticeavg   = (have_option('n', 'notices')) ? get_option_value('n', 'notices') : 100;
 428 $subsavg     = (have_option('b', 'subscriptions')) ? get_option_value('b', 'subscriptions') : max($usercount/20, 10);
 429 $joinsavg    = (have_option('j', 'joins')) ? get_option_value('j', 'joins') : 5;
 430 $favesavg    = (have_option('f', 'faves')) ? get_option_value('f', 'faves') : max($noticeavg/10, 5);
 431 $messageavg  = (have_option('m', 'messages')) ? get_option_value('m', 'messages') : max($noticeavg/10, 5);
 432 $tagmax      = (have_option('t', 'tags')) ? get_option_value('t', 'tags') : 10000;
 433 $userprefix  = (have_option('x', 'prefix')) ? get_option_value('x', 'prefix') : 'testuser';
 434 $groupprefix = (have_option('z', 'groupprefix')) ? get_option_value('z', 'groupprefix') : 'testgroup';
 435 $wordsfile   = (have_option('w', 'words')) ? get_option_value('w', 'words') : $defaultWordsfile;
 436
 437 if (is_readable($wordsfile)) {
 438     $words = file($wordsfile);
 439 } else {
 440    if ($wordsfile != $defaultWordsfile) {
 441       // user specified words file couldn't be read
 442       throw new Exception("Couldn't read words file: {$wordsfile}.");
 443     }
 444     $words = null;
 445 }
 446
 447 try {
 448     main($usercount, $groupcount, $noticeavg, $subsavg, $joinsavg, $favesavg, $messageavg, $tagmax);
 449 } catch (Exception $e) {
 450     printfv("Got an exception: ".$e->getMessage());
 451 }