/usr/share/php/Horde/Service/Weather/Base.php is in php-horde-service-weather 2.5.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | <?php
/**
* This file contains the Horde_Service_Weather_Base class for abstracting
* access to various weather providers.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Service_Weather
*/
/**
* Horde_Service_Weather_Base class
*
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @category Horde
* @package Service_Weather
*/
abstract class Horde_Service_Weather_Base
{
/**
* Parameters
*
* @var array
*/
protected $_params;
/**
* Cache object
*
* @var Horde_Cache
*/
protected $_cache;
/**
* Lifetime for cached data.
*
* @var integer
*/
protected $_cache_lifetime = 21600;
/**
* Units to display results in.
*
* @var integer
*/
public $units = Horde_Service_Weather::UNITS_STANDARD;
/**
* URL to a logo for this provider
*
* @var string
*/
public $logo;
/**
* URL to the provider's site
*
* @var string
*/
public $link;
/**
* Title for the provider
*
* @var string
*/
public $title;
/**
* Driver spcific icon map for condition icons. Made public so icons can
* be overridden in client code if desired.
*
* @var array
*/
public $iconMap = array();
/**
* The http client
*
* @var Horde_Http_Client
*/
protected $_http;
/**
* Local cache of current conditions
*
*/
protected $_current;
/**
* Local cache of forecast
*
* @var Horde_Service_Weather_Forecast_Base
*/
protected $_forecast;
/**
* Local cache of station data
*
* @var Horde_Service_Weather_Station
*/
protected $_station;
/**
* Last location requested.
*
* @var string
*/
protected $_lastLocation;
/**
* Last requested forecast length.
*
* @var integer
*/
protected $_lastLength;
protected $_alerts = array();
protected $_radar;
/**
* Constructor.
*
* @param array $params Parameters:
* - cache: (Horde_Cache) Optional Horde_Cache object.
* - cache_lifetime: (integer) Lifetime of cached data, if caching.
* - http_client: (Horde_Http_Client) Required http client object.
*/
public function __construct(array $params = array())
{
if (empty($params['http_client'])) {
throw new InvalidArgumentException('Missing http_client parameter.');
}
$this->_http = $params['http_client'];
unset($params['http_client']);
if (!empty($params['cache'])) {
$this->_cache = $params['cache'];
unset($params['cache']);
if (!empty($params['cache_lifetime'])) {
$this->_cache_lifetime = $params['cache_lifetime'];
unset($params['cache_lifetime']);
}
}
$this->_params = $params;
}
/**
* Returns the current observations.
*
* @param string $location The location string.
*
* @return Horde_Service_Weather_Current_Base
*/
abstract public function getCurrentConditions($location);
/**
* Returns the forecast for the current location.
*
* @param string $location The location code.
* @param integer $length The forecast length, a
* Horde_Service_Weather::FORECAST_* constant.
* @param integer $type The type of forecast to return, a
* Horde_Service_Weather::FORECAST_TYPE_* constant
*
* @return Horde_Service_Weather_Forecast_Base
*/
abstract public function getForecast(
$location,
$length = Horde_Service_Weather::FORECAST_3DAY,
$type = Horde_Service_Weather::FORECAST_TYPE_STANDARD);
/**
* Searches locations.
*
* @param string $location The location string to search.
* @param integer $type The type of search to perform, a
* Horde_Service_Weather::SEARCHTYPE_* constant.
*
* @return Horde_Service_Weather_Station The search location suitable to use
* directly in a weather request.
* @throws Horde_Service_Weather_Exception
*/
abstract public function searchLocations(
$location,
$type = Horde_Service_Weather::SEARCHTYPE_STANDARD);
/**
* Get array of supported forecast lengths.
*
* @return array The array of supported lengths.
*/
abstract public function getSupportedForecastLengths();
/**
* Return array of weather alerts, if available.
*
* @return array
*/
public function getAlerts($location)
{
return $this->_alerts;
}
/**
* Return the URL to a (possibly animated) radar image.
*
* @param string $location The location
*
* @return string|boolean The Url, or false if not available.
*/
public function getRadarImageUrl($location)
{
return false;
}
/**
* Return the URL a OpenLayers suitable tile server.
*
* @param string $location The location.
* @param string $type The optional layer type.
*
* @return string|boolean The Url, or false if not available.
*/
public function getTileServerUrl($location, $type = null)
{
return false;
}
/**
* Searches for locations that begin with the text in $search.
*
* @param string $search The text to search.
*
* @return array An array of stdClass objects with 'name' and 'code'
* properties.
* @throws Horde_Service_Weather_Exception
*/
public function autocompleteLocation($search)
{
throw new Horde_Service_Weather_Exception('Not implemented');
}
/**
* Returns a mapping of units for each UNIT type.
*
* @param integer $type The units for measurement. A
* Horde_Service_Weather::UNITS_* constant.
*
* @return array The mapping of measurements (as keys) and units (as values).
*/
public function getUnits($type = null)
{
if (empty($type)) {
$type = $this->units;
}
if ($type == Horde_Service_Weather::UNITS_STANDARD) {
return array(
'temp' => Horde_Service_Weather_Translation::t('F'),
'wind' => Horde_Service_Weather_Translation::t('mph'),
'pres' => Horde_Service_Weather_Translation::t('inches'),
'vis' => Horde_Service_Weather_Translation::t('miles'),
'rain' => Horde_Service_Weather_Translation::t('inches'),
'snow' => Horde_Service_Weather_Translation::t('inches'),
);
}
return array(
'temp' => Horde_Service_Weather_Translation::t('C'),
'wind' => Horde_Service_Weather_Translation::t('kph'),
'pres' => Horde_Service_Weather_Translation::t('millibars'),
'vis' => Horde_Service_Weather_Translation::t('km'),
'rain' => Horde_Service_Weather_Translation::t('millimeters'),
'snow' => Horde_Service_Weather_Translation::t('centimeters'),
);
}
/**
* Returns the station information associated with the last request.
*
* @return Horde_Service_Weather_Station
* @throws Horde_Service_Weather_Exception if not request has yet been made.
*/
public function getStation()
{
if (empty($this->_station)) {
throw new Horde_Service_Weather_Exception('No request made.');
}
return $this->_station;
}
/**
* Check if an IP address is a globally unique address and not in RFC1918 or
* RFC3330 address space.
*
* @param string $ip The IPv4 IP address to check.
*
* @return boolean True if the IP address is globally unique, otherwise
* false.
* @link http://tools.ietf.org/html/rfc3330
* @link http://www.faqs.org/rfcs/rfc1918.html
*/
protected function _ipIsUnique($ip)
{
// Make sure it's sane
$parts = explode('.', $ip);
if (count($parts) != 4) {
return false;
}
// zero config IPs RFC3330
if ($parts[0] == 169 && $parts[1] == 254) {
return false;
}
// reserved RFC 1918
if ($parts[0] == 10 ||
($parts[0] == 192 && $parts[1] == 168) ||
($parts[0] == 172 && ($parts[1] >= 16 && $parts[1] <= 31))) {
return false;
}
// Loopback
if ($parts[0] == 127) {
return false;
}
return true;
}
}
|