AutorÃa | Ultima modificación | Ver Log |
<?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();/** @var string API URL. */protected $api;/** @var string user ID. */protected $userid;/** @var string username. */protected $username;/** @var string token key. */protected $token;public function __construct($url = '') {if (empty($url)) {$this->api = 'https://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($titles);}$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* @param bool $force When true, forces the generation of a thumb URL.* @global object OUTPUT* @return string*/public function get_thumb_url($image_url, $orig_width, $orig_height, $thumb_width = 75, $force = false) {global $OUTPUT;if (!$force && $orig_width <= $thumb_width && $orig_height <= $thumb_width) {return $image_url;} else {$thumb_url = '';$commons_main_dir = 'https://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 gifsreturn $OUTPUT->image_url(file_extension_icon('.gif'))->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);$issvg = strcmp($extension, 'svg') == 0;// Get PNG equivalent to SVG files.if ($issvg) {$title .= '.png';}// The thumbnail (max size requested) is smaller than the original size, we will use the thumbnail.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'];}// We use the original file.} else {$attrs = array(//upload full size image'image_width' => $page['imageinfo'][0]['width'],'image_height' => $page['imageinfo'][0]['height'],'size' => $page['imageinfo'][0]['size']);// We cannot use the source when the file is SVG.if ($issvg) {// So we generate a PNG thumbnail of the file at its original size.$attrs['source'] = $this->get_thumb_url($page['imageinfo'][0]['url'], $page['imageinfo'][0]['width'],$page['imageinfo'][0]['height'], $page['imageinfo'][0]['width'], true);} else {$attrs['source'] = $page['imageinfo'][0]['url'];}}$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->image_url(file_extension_icon(substr($title, 5)))->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;}}