classes/geocoder.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 // Interface for an address geocoder. It provides support for transforming a
  23 // free form address into a fully structured one.
  24 abstract class Geocoder {
  25     // Geocodes @p the address, and returns the corresponding updated address.
  26     // Unknown key-value pairs available in the input map are retained as-is.
  27     abstract public function getGeocodedAddress(Address &$address);
  28
  29     // Cleans the address from its geocoded data
  30     abstract public function stripGeocodingFromAddress(Address &$address);
  31
  32     // Updates geoloc_administrativeareas, geoloc_subadministrativeareas and
  33     // geoloc_localities databases with new geocoded data and returns the
  34     // corresponding id.
  35     static public function getAreaId(Address &$address, $area)
  36     {
  37         static $databases = array(
  38             'administrativeArea'    => 'geoloc_administrativeareas',
  39             'subAdministrativeArea' => 'geoloc_subadministrativeareas',
  40             'locality'              => 'geoloc_localities',
  41         );
  42
  43         $areaName = $area . 'Name';
  44         $areaNameLocal = $areaName . 'Local';
  45         $areaId = $area . 'Id';
  46         if (!is_null($address->$areaName) && isset($databases[$area])) {
  47             $res = XDB::query('SELECT  id, nameLocal
  48                                  FROM  ' . $databases[$area] . '
  49                                 WHERE  name = {?}',
  50                               $address->$areaName);
  51             if ($res->numRows() == 0) {
  52                 XDB::execute('INSERT INTO  ' . $databases[$area] . ' (name, nameLocal, country)
  53                                    VALUES  ({?}, {?}, {?})',
  54                              $address->$areaName, $address->$areaNameLocal, $address->countryId);
  55                 $address->$areaId = XDB::insertId();
  56             } else {
  57                 // XXX: remove this once all areas have both nameLocal and name.
  58                 list($id, $name) = $res->fetchOneRow();
  59                 if (is_null($name) && !is_null($address->$areaNameLocal)) {
  60                     XDB::execute('UPDATE  ' . $databases[$area] . '
  61                                      SET  nameLocal = {?}
  62                                    WHERE  id = {?}',
  63                                  $address->$areaNameLocal, $id);
  64                 }
  65                 $address->$areaId = $id;
  66             }
  67         } elseif (empty($address->$areaId)) {
  68             $address->$areaId = null;
  69         }
  70     }
  71
  72     // Returns the part of the text preceeding the line with the postal code
  73     // and the city name, within the limit of $limit number of lines.
  74     static public function getFirstLines($text, $postalCode, $limit)
  75     {
  76         $textArray  = explode("\n", $text);
  77         for ($i = 0; $i < count($textArray); ++$i) {
  78             if ($i > $limit || strpos($textLine, $postalCode) !== false) {
  79                 $limit = $i;
  80                 break;
  81             }
  82         }
  83         return implode("\n", array_slice($textArray, 0, $limit));
  84     }
  85
  86     // Returns the number of non geocoded addresses for a user.
  87     static public function countNonGeocoded($pid, $jobid = null, $type = Address::LINK_PROFILE)
  88     {
  89         $where = array();
  90         if (!is_null($pid)) {
  91             $where[] = XDB::format('pid = {?}', $pid);
  92         }
  93         if (!is_null($jobid)) {
  94             $where[] = XDB::format('jobid = {?}', $jobid);
  95         }
  96         $where[] = XDB::format('FIND_IN_SET({?}, type) AND accuracy = 0', $type);
  97         $res = XDB::query('SELECT  COUNT(*)
  98                              FROM  profile_addresses
  99                             WHERE  ' . implode(' AND ', $where),
 100                           $pid);
 101         return $res->fetchOneCell();
 102     }
 103 }
 104
 105 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 106 ?>