citation-bot/setup.php at master · In1quity/citation-bot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?php

declare(strict_types=1);

// These lines should be included if webserver does not block these
//if (get_included_files()[0] === __FILE__) {
//    exit;
//}

error_reporting(E_ALL);

date_default_timezone_set('UTC');
ob_implicit_flush(true);
flush();

if (file_exists('git_pull.lock')) {
    sleep(5);
    echo '<!DOCTYPE html><html lang="en" dir="ltr"><head><title>Citation Bot: error</title></head><body><h1>GIT pull in progress - please retry again in a moment</h1></body></html>';
    exit;
}

/*
 * setup.php sets up the environment
 * Most of the page expansion depends on everything else
 */

function bot_debug_log(string $log_this): void {
    @clearstatcache(); // Deal with multiple writers, but not so paranoid that we get a file lock
    if (function_exists('echoable')) {
        // Avoid making a new huge string, so do not combine
        file_put_contents('CodeCoverage', echoable(WikipediaBot::GetLastUser()) . " :: " . echoable(Page::$last_title) . " :: ", FILE_APPEND);
        file_put_contents('CodeCoverage', $log_this, FILE_APPEND);
        file_put_contents('CodeCoverage', "\n", FILE_APPEND);
    }
}

if (isset($_REQUEST["wiki_base"])){
    $wiki_base = trim((string) $_REQUEST["wiki_base"]);
    if (!in_array($wiki_base, ['en', 'simple', 'mk', 'ru', 'mdwiki'], true)) {
        echo '<!DOCTYPE html><html lang="en" dir="ltr"><head><title>Citation Bot: error</title></head><body><h1>Unsupported wiki requested - aborting</h1></body></html>';
        exit;
    }
} else {
    $wiki_base = 'en';
}
if ($wiki_base === 'mdwiki') {
    define("WIKI_ROOT", 'https://mdwiki.org/w/index.php');
    define("API_ROOT", 'https://mdwiki.org/w/api.php');
} else {
    define("WIKI_ROOT", 'https://'. $wiki_base . '.wikipedia.org/w/index.php');
    define("API_ROOT", 'https://'. $wiki_base . '.wikipedia.org/w/api.php');
}
unset($wiki_base);

require_once 'constants.php';

ini_set("user_agent", BOT_USER_AGENT);
include_once './vendor/autoload.php';

define("TRAVIS", (bool) getenv('CI') || defined('__PHPUNIT_PHAR__') || defined('PHPUNIT_COMPOSER_INSTALL') || (strpos((string) @$_SERVER['argv'][0], 'phpunit') !== false));

if ((string) @$_REQUEST["page"] . (string) @$argv[1] === "User:AManWithNoPlan/sandbox3") { // Specific page to make sure this code path keeps working
    define('EDIT_AS_USER', true);
}

if (TRAVIS || isset($argv)) {
    define("HTML_OUTPUT", false);
} else {
    define("HTML_OUTPUT", true);
}

// This is needed because the Gadget API expects only JSON back, therefore ALL output from the citation bot is thrown away
if (strpos((string) @$_SERVER['PHP_SELF'], '/gadgetapi.php') === false) {
    define("FLUSHING_OKAY", true);
} else {
    define("FLUSHING_OKAY", false);
}

if (isset($_REQUEST["slow"]) || TRAVIS || (isset($argv) && in_array('--slow', $argv, true))) {
    define("SLOW_MODE", true);
} else {
    define("SLOW_MODE", false);
}

if (isset($argv) && in_array('--savetofiles', $argv, true)) {
    define("SAVETOFILES_MODE", true);
} else {
    define("SAVETOFILES_MODE", false);
}

if (file_exists('env.php')) {
    // Set the environment variables with putenv(). Remember to set permissions (not readable!)
    ob_start();
    /** @psalm-suppress MissingFile */
    include_once 'env.php';
    $env_output = trim(ob_get_contents());
    if ($env_output) {
        bot_debug_log("got this:\n" . $env_output);  // Something unexpected, so log it
    }
    unset($env_output);
    ob_end_clean();
}

if (!mb_internal_encoding('UTF-8') || !mb_regex_encoding('UTF-8')) { /** @phpstan-ignore-line */ /** We are very paranoid */
    echo 'Unable to set encoding';
    exit;
}

ini_set("memory_limit", "3648M"); // Use Megabytes to match memory usage check code
ini_set("pcre.backtrack_limit", "1425000000");
ini_set("pcre.recursion_limit", "425000000");
if (isset($_REQUEST["pcre"]) || (strpos((string) @$_SERVER['PHP_SELF'], '/gadgetapi.php') !== false)) { // Willing to take slight performance penalty on Gadget
    ini_set("pcre.jit", "0");
}

if (isset($_REQUEST['PHP_ADSABSAPIKEY'])) {
    $key = (string) $_REQUEST['PHP_ADSABSAPIKEY'];
    $key = trim($key);
    if (preg_match('~^[a-zA-Z0-9]{16,120}$~', $key)) {
        define('PHP_ADSABSAPIKEY', $key);
    } else {
        exit;
    }
} else {
    define('PHP_ADSABSAPIKEY', (string) getenv('PHP_ADSABSAPIKEY'));
}

$env_limit_action = trim((string) getenv("PHP_ADSABSAPILIMITACTION"));
if ($env_limit_action !== '') {
    define("PHP_ADSABSAPILIMITACTION", $env_limit_action);
}
unset($env_limit_action);

if ((string) getenv("PHP_S2APIKEY") !== "") {
    define("HEADER_S2", [CURLOPT_HTTPHEADER => ["x-api-key: " . (string) getenv("PHP_S2APIKEY")]]);
} else {
    define("HEADER_S2", []);
}

// see https://www.ncbi.nlm.nih.gov/books/NBK25497/ for more information
// Without an API key, any site IP address posting more than 3 requests per second will receive an error message.
$nlm_tool = "WikipediaCitationBot";
$nlm_apikey = (string) getenv("NLM_APIKEY");
$nlm_email = (string) getenv("NLM_EMAIL");
if (!(strpos($nlm_email, '@') > 0)) {
    $nlm_email = PUBMEDUSERNAME;
}
if (strlen($nlm_apikey) < 8) {
    $nlm_apikey = "";
}
define("NLM_LOGIN", "tool=" . urlencode($nlm_tool) . "&email=" . urlencode($nlm_email) . (($nlm_apikey === "") ? "" : ("&api_key=" . urlencode($nlm_apikey))));
unset($nlm_email, $nlm_apikey, $nlm_tool);

function check_blocked(): void {
    if (!TRAVIS && ! WikipediaBot::is_valid_user('Citation_bot')) {
        echo '</pre><div style="text-align:center"><h1>The Citation Bot is currently blocked because of disagreement over its usage.</h1><br/><h2><a href="https://en.wikipedia.org/wiki/User_talk:Citation_bot" title="Join the discussion" target="_blank"  aria-label="Join the discussion (opens a new window)">Please join in the discussion</a></h2></div><footer><a href="./" title="Use Citation Bot again">Another&nbsp;page</a>?</footer></body></html>';
        exit;
    }
}

define("MAX_TRIES", 2);
require_once 'Comment.php';
require_once 'user_messages.php';
require_once 'NameTools.php';
require_once 'WikipediaBot.php';
require_once 'Parameter.php';
require_once 'expandFns.php';
require_once 'Template.php';
require_once 'Zotero.php';
require_once 'apiFunctions.php';
require_once 'Page.php';

if (isset($argv)) {
    define("MAX_PAGES", 1000000);
} else {
    define("MAX_PAGES", 3850);
}

if (!TRAVIS) { // This is explicity "tested" in test suite
    Zotero::create_ch_zotero();
    WikipediaBot::make_ch();
}