-
Notifications
You must be signed in to change notification settings - Fork 4
/
IsoSubdivisionL10n.php
203 lines (180 loc) · 5.02 KB
/
IsoSubdivisionL10n.php
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<?php
/**
* Handles localisation of ISO subdivision names using interwiki lang links
*
* Only supports json output format at the moment.
* * @author <arichards@wikimedia.org>
*/
class SubdivisionL10n {
protected $query_url = 'http://en.wikipedia.org/w/api.php';
protected $lllimit = 500;
protected $format = 'json';
protected $titles = '';
protected $lllang = 'en';
protected $apiResult = array();
public $debug = false;
public function getQueryUrl() {
return $this->query_url;
}
/**
* @TODO enforce a sane url
*/
public function setQueryUrl( $url ) {
$this->query_url = $url;
}
public function getLimit() {
return $this->lllimit;
}
public function setLimit( $limit ) {
if ( !is_numeric( $limit ) ) {
$limit = 0;
}
$this->lllimit = intval( $limit );
}
public function getForamt() {
return $this->format;
}
public function setFormat( $format ) {
$this->format = $format;
}
public function getTitles() {
return $this->titles;
}
public function setTitles( $titles ) {
if ( is_array( $titles ) ) {
$titles = implode( "|", $titles );
}
$this->titles = $titles;
}
public function getLang() {
return $this->lllang;
}
public function setLang( $lang ) {
$this->lllang = $lang;
}
public function setApiResult( $apiResult ) {
$this->apiResult = $apiResult;
}
public function getApiResult( $query=false ) {
if ( $query === true ) {
$this->queryApi();
}
return $this->apiResult;
}
/**
* Prepares API query parameters
*
* @return array
*/
protected function getQueryParams() {
return array(
'action' => 'query',
'prop' => 'langlinks',
'redirects' => '',
'lllimit' => $this->getLimit(),
'format' => $this->getForamt(),
'titles' => $this->getTitles(),
'lllang' => $this->getLang()
);
}
/**
* Query the API and store the result in an object property
*/
public function queryApi() {
if ( $this->debug ) {
$this->debug( 'Query URL', $this->getQueryUrl() );
$this->debug( 'Query Params', print_r( $this->getQueryParams(), true ) );
}
$apiResult = static::getApiResults( $this->getQueryUrl(), $this->getQueryParams() );
$this->apiResult = json_decode( $apiResult, true );
if ( $this->debug ) $this->debug( 'Api result', print_r( $this->apiResult, true ) );
}
/**
* Fetches any redirect information from an api query result
*
* @return array|bool
*/
public function getRedirects() {
$apiResult = $this->getApiResult();
if ( !is_array( $apiResult['query'] ) || !in_array( 'redirects', array_keys( $apiResult['query'] ) ) ) {
return false;
} else {
return $apiResult['query']['redirects'];
}
}
/**
* Use curl to query the API
* @TODO this is pretty basic - it would be nice to support
* authentication, etc.
*/
public static function getApiResults( $url, $params, $i=0 ) {
$i++; // keep track of attempts
$ch = curl_init();
curl_setopt( $ch, CURLOPT_USERAGENT, 'ISO-3166-2 l10n 0.1' );
curl_setopt( $ch, CURLOPT_ENCODING, "UTF-8" );
curl_setopt( $ch, CURLOPT_URL, $url );
curl_setopt( $ch, CURLOPT_POST, 1 );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $params );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
// quiet 'HTTP/1.0 417 Expectation failed' error by disabling the header
curl_setopt( $ch, CURLOPT_HTTPHEADER, array( "Expect:" ) );
// curl_setopt( $ch, CURLOPT_VERBOSE, 1 );
$ret = curl_exec( $ch );
if ( curl_errno( $ch ) ) {
if ( $i <= 3 ) {
sleep( 15 );
getApiResults( $url, $params, $i );
} else {
throw new Exception( sprintf( 'Curl error: %s', curl_error( $ch ) ) ) ;
}
}
curl_close( $ch );
return $ret;
}
/**
* Formats a localised subdivision record
*
* @param string $country_iso_code
* @param string $iso_code
* @param string $name
* @param string $level_name
* @return string
*/
public static function formatL10nRecord( $country_iso_code, $iso_code, $name, $level_name ) {
$str = '$subdivisions[\'%s\'][\'%s\'] = array(' . PHP_EOL;
$str .= '\'name\' => \'%s\',' . PHP_EOL;
$str .= '\'level\' => \'%s\',' . PHP_EOL;
$str .= ');' . PHP_EOL;
return sprintf( $str, $country_iso_code, $iso_code, $name, $level_name );
}
/**
* Does a little cleanup on subdivision names
*
* Some names (either from the CSV or coming back from the language links)
* have erroneous information and/or characters in them. This gets rid
* of the cruft.
*
* @param string $name
* @return string
*/
public static function fixL10nName( $name ) {
$pattern = array(
"/\([^\)]+\)/", // remove any text in parens - eg 'California (state)'
"/,.*[^D\.C\.]$/", // remove a comma and anything after it, except 'D.C.' (ugly Washington, D.C. hack)
"/\*+/", // remove any * symbols
"/\[.*\]/", // remove anything contained in square brackets
);
$name_l10n = preg_replace( $pattern, '', $name );
// trim and addslashes
return trim( addslashes( $name_l10n ) );
}
/**
* Debug output helper method
*
* @param string $preface
* @param string $log_item
*/
private function debug( $preface, $log_item ) {
echo $preface . ": " . $log_item . PHP_EOL;
}
}