MediaWiki  master
createCommonPasswordCdb.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
39  public function __construct() {
40  global $IP;
41  parent::__construct();
42  $this->addDescription( 'Generate CDB file of common passwords' );
43  $this->addOption( 'limit', "Max number of passwords to write", false, true, 'l' );
44  $this->addArg( 'inputfile', 'List of passwords (one per line) to use or - for stdin', true );
45  $this->addArg(
46  'output',
47  "Location to write CDB file to (Try $IP/includes/password/commonpasswords.cdb)",
48  true
49  );
50  }
51 
52  public function execute() {
53  $limit = (int)$this->getOption( 'limit', PHP_INT_MAX );
54  $langEn = Language::factory( 'en' );
55 
56  $infile = $this->getArg( 0 );
57  if ( $infile === '-' ) {
58  $infile = 'php://stdin';
59  }
60  $outfile = $this->getArg( 1 );
61 
62  if ( !is_readable( $infile ) && $infile !== 'php://stdin' ) {
63  $this->fatalError( "Cannot open input file $infile for reading" );
64  }
65 
66  $file = fopen( $infile, 'r' );
67  if ( $file === false ) {
68  $this->fatalError( "Cannot read input file $infile" );
69  }
70 
71  try {
72  $db = \Cdb\Writer::open( $outfile );
73 
74  $alreadyWritten = [];
75  $skipped = 0;
76  for ( $i = 0; ( $i - $skipped ) < $limit; $i++ ) {
77  if ( feof( $file ) ) {
78  break;
79  }
80  $rawLine = fgets( $file );
81 
82  if ( $rawLine === false ) {
83  $this->error( "Error reading input file" );
84  break;
85  }
86  if ( substr( $rawLine, -1 ) !== "\n" && !feof( $file ) ) {
87  // We're assuming that this just won't happen.
88  $this->error( "fgets did not return whole line at $i??" );
89  }
90  $line = $langEn->lc( trim( $rawLine ) );
91  if ( $line === '' ) {
92  $this->error( "Line number " . ( $i + 1 ) . " is blank?" );
93  $skipped++;
94  continue;
95  }
96  if ( isset( $alreadyWritten[$line] ) ) {
97  $this->output( "Password '$line' already written (line " . ( $i + 1 ) . ")\n" );
98  $skipped++;
99  continue;
100  }
101  $alreadyWritten[$line] = true;
102  $db->set( $line, $i + 1 - $skipped );
103  }
104  // All caps, so cannot conflict with potential password
105  $db->set( '_TOTALENTRIES', $i - $skipped );
106  $db->close();
107 
108  $this->output( "Successfully wrote " . ( $i - $skipped ) .
109  " (out of $i) passwords to $outfile\n"
110  );
111  } catch ( \Cdb\Exception $e ) {
112  $this->fatalError( "Error writing cdb file: " . $e->getMessage(), 2 );
113  }
114  }
115 }
116 
117 $maintClass = CreateCommonPasswordCdb::class;
118 require_once RUN_MAINTENANCE_IF_MAIN;
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
getArg( $argId=0, $default=null)
Get an argument.
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
error( $err, $die=0)
Throw an error to the user.
$IP
Definition: WebStart.php:41
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:86
Maintenance script to create common password cdb database.
addDescription( $text)
Set the description text.
addArg( $arg, $description, $required=true)
Add some args that are needed.
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:212
output( $out, $channel=null)
Throw some output to the user.
$line
Definition: cdb.php:59
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.