mirrored from git://git.moodle.org/moodle.git
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
wikimedia.php
220 lines (212 loc) · 9.43 KB
/
wikimedia.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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* wikimedia class
* class for communication with Wikimedia Commons API
*
* @author Dongsheng Cai <dongsheng@moodle.com>, Raul Kern <raunator@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
*/
define('WIKIMEDIA_THUMBS_PER_PAGE', 24);
define('WIKIMEDIA_FILE_NS', 6);
define('WIKIMEDIA_IMAGE_SIDE_LENGTH', 1024);
define('WIKIMEDIA_THUMB_SIZE', 120);
class wikimedia {
private $_conn = null;
private $_param = array();
public function __construct($url = '') {
if (empty($url)) {
$this->api = 'http://commons.wikimedia.org/w/api.php';
} else {
$this->api = $url;
}
$this->_param['format'] = 'php';
$this->_param['redirects'] = true;
$this->_conn = new curl(array('cache'=>true, 'debug'=>false));
}
public function login($user, $pass) {
$this->_param['action'] = 'login';
$this->_param['lgname'] = $user;
$this->_param['lgpassword'] = $pass;
$content = $this->_conn->post($this->api, $this->_param);
$result = unserialize($content);
if (!empty($result['result']['sessionid'])) {
$this->userid = $result['result']['lguserid'];
$this->username = $result['result']['lgusername'];
$this->token = $result['result']['lgtoken'];
return true;
} else {
return false;
}
}
public function logout() {
$this->_param['action'] = 'logout';
$content = $this->_conn->post($this->api, $this->_param);
return;
}
public function get_image_url($titles) {
$image_urls = array();
$this->_param['action'] = 'query';
if (is_array($titles)) {
foreach ($titles as $title) {
$this->_param['titles'] .= ('|'.urldecode($title));
}
} else {
$this->_param['titles'] = urldecode($title);
}
$this->_param['prop'] = 'imageinfo';
$this->_param['iiprop'] = 'url';
$content = $this->_conn->post($this->api, $this->_param);
$result = unserialize($content);
foreach ($result['query']['pages'] as $page) {
if (!empty($page['imageinfo'][0]['url'])) {
$image_urls[] = $page['imageinfo'][0]['url'];
}
}
return $image_urls;
}
public function get_images_by_page($title) {
$image_urls = array();
$this->_param['action'] = 'query';
$this->_param['generator'] = 'images';
$this->_param['titles'] = urldecode($title);
$this->_param['prop'] = 'images|info|imageinfo';
$this->_param['iiprop'] = 'url';
$content = $this->_conn->post($this->api, $this->_param);
$result = unserialize($content);
if (!empty($result['query']['pages'])) {
foreach ($result['query']['pages'] as $page) {
$image_urls[$page['title']] = $page['imageinfo'][0]['url'];
}
}
return $image_urls;
}
/**
* Generate thumbnail URL from image URL.
*
* @param string $image_url
* @param int $orig_width
* @param int $orig_height
* @param int $thumb_width
* @global object OUTPUT
* @return string
*/
public function get_thumb_url($image_url, $orig_width, $orig_height, $thumb_width=75) {
global $OUTPUT;
if ($orig_width <= $thumb_width AND $orig_height <= $thumb_width) {
return $image_url;
} else {
$thumb_url = '';
$commons_main_dir = 'http://upload.wikimedia.org/wikipedia/commons/';
if ($image_url) {
$short_path = str_replace($commons_main_dir, '', $image_url);
$extension = strtolower(pathinfo($short_path, PATHINFO_EXTENSION));
if (strcmp($extension, 'gif') == 0) { //no thumb for gifs
return $OUTPUT->pix_url(file_extension_icon('.gif', $thumb_width))->out(false);
}
$dir_parts = explode('/', $short_path);
$file_name = end($dir_parts);
if ($orig_height > $orig_width) {
$thumb_width = round($thumb_width * $orig_width/$orig_height);
}
$thumb_url = $commons_main_dir . 'thumb/' . implode('/', $dir_parts) . '/'. $thumb_width .'px-' . $file_name;
if (strcmp($extension, 'svg') == 0) { //png thumb for svg-s
$thumb_url .= '.png';
}
}
return $thumb_url;
}
}
/**
* Search for images and return photos array.
*
* @param string $keyword
* @param int $page
* @param array $params additional query params
* @return array
*/
public function search_images($keyword, $page = 0, $params = array()) {
global $OUTPUT;
$files_array = array();
$this->_param['action'] = 'query';
$this->_param['generator'] = 'search';
$this->_param['gsrsearch'] = $keyword;
$this->_param['gsrnamespace'] = WIKIMEDIA_FILE_NS;
$this->_param['gsrlimit'] = WIKIMEDIA_THUMBS_PER_PAGE;
$this->_param['gsroffset'] = $page * WIKIMEDIA_THUMBS_PER_PAGE;
$this->_param['prop'] = 'imageinfo';
$this->_param['iiprop'] = 'url|dimensions|mime|timestamp|size|user';
$this->_param += $params;
$this->_param += array('iiurlwidth' => WIKIMEDIA_IMAGE_SIDE_LENGTH,
'iiurlheight' => WIKIMEDIA_IMAGE_SIDE_LENGTH);
//didn't work with POST
$content = $this->_conn->get($this->api, $this->_param);
$result = unserialize($content);
if (!empty($result['query']['pages'])) {
foreach ($result['query']['pages'] as $page) {
$title = $page['title'];
$file_type = $page['imageinfo'][0]['mime'];
$image_types = array('image/jpeg', 'image/png', 'image/gif', 'image/svg+xml');
if (in_array($file_type, $image_types)) { //is image
$extension = pathinfo($title, PATHINFO_EXTENSION);
if (strcmp($extension, 'svg') == 0) { //upload png version of svg-s
$title .= '.png';
}
if ($page['imageinfo'][0]['thumbwidth'] < $page['imageinfo'][0]['width']) {
$attrs = array(
//upload scaled down image
'source' => $page['imageinfo'][0]['thumburl'],
'image_width' => $page['imageinfo'][0]['thumbwidth'],
'image_height' => $page['imageinfo'][0]['thumbheight']
);
if ($attrs['image_width'] <= WIKIMEDIA_THUMB_SIZE && $attrs['image_height'] <= WIKIMEDIA_THUMB_SIZE) {
$attrs['realthumbnail'] = $attrs['source'];
}
if ($attrs['image_width'] <= 24 && $attrs['image_height'] <= 24) {
$attrs['realicon'] = $attrs['source'];
}
} else {
$attrs = array(
//upload full size image
'source' => $page['imageinfo'][0]['url'],
'image_width' => $page['imageinfo'][0]['width'],
'image_height' => $page['imageinfo'][0]['height'],
'size' => $page['imageinfo'][0]['size']
);
}
$attrs += array(
'realthumbnail' => $this->get_thumb_url($page['imageinfo'][0]['url'], $page['imageinfo'][0]['width'], $page['imageinfo'][0]['height'], WIKIMEDIA_THUMB_SIZE),
'realicon' => $this->get_thumb_url($page['imageinfo'][0]['url'], $page['imageinfo'][0]['width'], $page['imageinfo'][0]['height'], 24),
'author' => $page['imageinfo'][0]['user'],
'datemodified' => strtotime($page['imageinfo'][0]['timestamp']),
);
} else { // other file types
$attrs = array('source' => $page['imageinfo'][0]['url']);
}
$files_array[] = array(
'title'=>substr($title, 5), //chop off 'File:'
'thumbnail' => $OUTPUT->pix_url(file_extension_icon(substr($title, 5), WIKIMEDIA_THUMB_SIZE))->out(false),
'thumbnail_width' => WIKIMEDIA_THUMB_SIZE,
'thumbnail_height' => WIKIMEDIA_THUMB_SIZE,
'license' => 'cc-sa',
// the accessible url of the file
'url'=>$page['imageinfo'][0]['descriptionurl']
) + $attrs;
}
}
return $files_array;
}
}