lib-php/ParameterParser.php

   1 <?php
   2 /**
   3  * SPDX-License-Identifier: GPL-2.0-only
   4  *
   5  * This file is part of Nominatim. (https://nominatim.org)
   6  *
   7  * Copyright (C) 2022 by the Nominatim developer community.
   8  * For a full list of authors see the git log.
   9  */
  10
  11 namespace Nominatim;
  12
  13 class ParameterParser
  14 {
  15     private $aParams;
  16
  17
  18     public function __construct($aParams = null)
  19     {
  20         $this->aParams = ($aParams === null) ? $_GET : $aParams;
  21     }
  22
  23     public function getBool($sName, $bDefault = false)
  24     {
  25         if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
  26             return $bDefault;
  27         }
  28
  29         return (bool) $this->aParams[$sName];
  30     }
  31
  32     public function getInt($sName, $bDefault = false)
  33     {
  34         if (!isset($this->aParams[$sName])) {
  35             return $bDefault;
  36         }
  37
  38         if (!preg_match('/^[+-]?[0-9]+$/', $this->aParams[$sName])) {
  39             userError("Integer number expected for parameter '$sName'");
  40         }
  41
  42         return (int) $this->aParams[$sName];
  43     }
  44
  45     public function getFloat($sName, $bDefault = false)
  46     {
  47         if (!isset($this->aParams[$sName])) {
  48             return $bDefault;
  49         }
  50
  51         if (!preg_match('/^[+-]?[0-9]*\.?[0-9]+$/', $this->aParams[$sName])) {
  52             userError("Floating-point number expected for parameter '$sName'");
  53         }
  54
  55         return (float) $this->aParams[$sName];
  56     }
  57
  58     public function getString($sName, $bDefault = false)
  59     {
  60         if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
  61             return $bDefault;
  62         }
  63
  64         return $this->aParams[$sName];
  65     }
  66
  67     public function getSet($sName, $aValues, $sDefault = false)
  68     {
  69         if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
  70             return $sDefault;
  71         }
  72
  73         if (!in_array($this->aParams[$sName], $aValues)) {
  74             userError("Parameter '$sName' must be one of: ".join(', ', $aValues));
  75         }
  76
  77         return $this->aParams[$sName];
  78     }
  79
  80     public function getStringList($sName, $aDefault = false)
  81     {
  82         $sValue = $this->getString($sName);
  83
  84         if ($sValue) {
  85             // removes all NULL, FALSE and Empty Strings but leaves 0 (zero) values
  86             return array_values(array_filter(explode(',', $sValue), 'strlen'));
  87         }
  88
  89         return $aDefault;
  90     }
  91
  92     public function getPreferredLanguages($sFallback = null)
  93     {
  94         if ($sFallback === null && isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
  95             $sFallback = $_SERVER['HTTP_ACCEPT_LANGUAGE'];
  96         }
  97
  98         $aLanguages = array();
  99         $sLangString = $this->getString('accept-language', $sFallback);
 100
 101         if ($sLangString
 102             && preg_match_all('/(([a-z]{1,8})([-_][a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i', $sLangString, $aLanguagesParse, PREG_SET_ORDER)
 103         ) {
 104             foreach ($aLanguagesParse as $iLang => $aLanguage) {
 105                 $aLanguages[$aLanguage[1]] = isset($aLanguage[5])?(float)$aLanguage[5]:1 - ($iLang/100);
 106                 if (!isset($aLanguages[$aLanguage[2]])) {
 107                     $aLanguages[$aLanguage[2]] = $aLanguages[$aLanguage[1]]/10;
 108                 }
 109             }
 110             arsort($aLanguages);
 111         }
 112         if (empty($aLanguages) && CONST_Default_Language) {
 113             $aLanguages[CONST_Default_Language] = 1;
 114         }
 115
 116         foreach ($aLanguages as $sLanguage => $fLanguagePref) {
 117             $this->addNameTag($aLangPrefOrder, $sLanguage);
 118         }
 119         $this->addNameTag($aLangPrefOrder, 'default');
 120         $this->addNameTag($aLangPrefOrder, 'brand');
 121
 122         foreach ($aLanguages as $sLanguage => $fLanguagePref) {
 123             $this->addNameTag($aLangPrefOrder, 'official_name:'.$sLanguage);
 124             $this->addNameTag($aLangPrefOrder, 'short_name:'.$sLanguage);
 125         }
 126         $this->addNameTag($aLangPrefOrder, 'official_name');
 127         $this->addNameTag($aLangPrefOrder, 'short_name');
 128         $this->addNameTag($aLangPrefOrder, 'ref');
 129         $this->addNameTag($aLangPrefOrder, 'type');
 130         return $aLangPrefOrder;
 131     }
 132
 133     private function addNameTag(&$aLangPrefOrder, $sTag)
 134     {
 135         $aLangPrefOrder[$sTag] = $sTag;
 136         $aLangPrefOrder['_place_'.$sTag] = '_place_'.$sTag;
 137     }
 138
 139     public function hasSetAny($aParamNames)
 140     {
 141         foreach ($aParamNames as $sName) {
 142             if ($this->getBool($sName)) {
 143                 return true;
 144             }
 145         }
 146
 147         return false;
 148     }
 149 }