Added get_order_state() and get_order_state_string().
[readifood.git] / lib / functions.php
1 <?php
2
3   function parse_parameters($parameters) {
4     $name = null;
5     $id = null;
6     $args = array();
7
8     if (count($parameters) > 0) {
9       $name = array_shift($parameters);
10
11       /* Recall that we shifted. */
12       if (count($parameters) > 0) {
13         if (is_numeric($parameters[0])) {
14           $id = array_shift($parameters);
15         }
16       }
17
18       $args = $parameters;
19     }
20
21     return array($name, $id, $args);
22   }
23
24   function get_city_by_name($name, $postcode_area = null, $verbose = true) {
25     $q = new CityQuery;
26
27     $m = $q->filterByName(urldecode($name));
28     if (isset($postcode_area)) {
29       $m->filterByPostcodeArea($postcode_area);
30     }
31     $cities = $m->find();
32
33     switch ($m->count()) {
34       case 0:
35         if ($verbose) echo "<p>No such city!</p>\n";
36         return null;
37
38       case 1:
39         return $cities[0];
40
41       default:
42         if ($verbose) echo "<p>Can't identify city uniquely.</p>!\n";
43         return null;
44     }
45   }
46
47   function get_city_by_id($id, $verbose = true) {
48     $q = new CityQuery;
49     $city = $q->findOneById($id);
50
51     if (! $q->count()) {
52       if ($verbose) echo "<p>No such city!</p>\n";
53       return null;
54     }
55
56     return $city;
57   }
58
59   function get_area_by_name($name, $verbose = true) {
60     $q = new AreaQuery;
61     $areas = $q->filterByName(urldecode($name))->find();
62
63     switch ($q->count()) {
64       case 0:
65         if ($verbose) echo "<p>No such area!</p>\n";
66         return null;
67
68       case 1:
69         return $areas[0];
70
71       default:
72         if ($verbose) echo "<p>Can't identify area uniquely.</p>!\n";
73         return null;
74     }
75   }
76
77   function get_area_by_id($id, $verbose = true) {
78     $q = new AreaQuery;
79     $area = $q->findOneById($id);
80
81     if (! $q->count()) {
82       if ($verbose) echo "<p>No such area!</p>\n";
83       return null;
84     }
85
86     return $area;
87   }
88
89   function get_area_city($area) {
90     $q = new CityQuery;
91     return $q->findOneById($area->getCityId());
92   }
93
94   function get_contact_by_name($name, $verbose = true) {
95     $q = new ContactQuery;
96     $contact = $q->filterByDisplayname(urldecode($name))->find();
97
98     switch ($q->count()) {
99       case 0:
100         if ($verbose) echo "<p>No such contact!</p>\n";
101         return null;
102
103       case 1:
104         return $contacts[0];
105
106       default:
107         if ($verbose) echo "<p>Can't identify contact uniquely.</p>!\n";
108         return null;
109     }
110   }
111
112   function get_contact_by_id($id, $verbose = true) {
113     $q = new ContactQuery;
114     $contact = $q->findOneById($id);
115
116     if (! $q->count()) {
117       if ($verbose) echo "<p>No such contact!</p>\n";
118       return null;
119     }
120
121     return $contact;
122   }
123
124   function get_hub_by_name($name, $verbose = true) {
125     $q = new HubQuery;
126     $hubs = $q->filterByDisplayname(urldecode($name))->find();
127
128     switch ($q->count()) {
129       case 0:
130         if ($verbose) echo "<p>No such hub!</p>\n";
131         return null;
132
133       case 1:
134         return $hubs[0];
135
136       default:
137         if ($verbose) echo "<p>Can't identify hub uniquely.</p>!\n";
138         return null;
139     }
140   }
141
142   function get_hub_by_id($id, $verbose = true) {
143     $q = new HubQuery;
144     $hub = $q->findOneById($id);
145
146     if (! $q->count()) {
147       if ($verbose) echo "<p>No such hub!</p>\n";
148       return null;
149     }
150
151     return $hub;
152   }
153
154   function get_donation_by_id($id, $verbose = true) {
155     $q = new DonationQuery;
156     $donation = $q->findOneById($id);
157
158     if (! $q->count()) {
159       if ($verbose) echo "<p>No such donation!</p>\n";
160       return null;
161     }
162
163     return $donation;
164   }
165
166   function get_order_by_id($id, $verbose = true) {
167     $q = new OrderQuery;
168     $order = $q->findOneById($id);
169
170     if (! $q->count()) {
171       if ($verbose) echo "<p>No such order!</p>\n";
172       return null;
173     }
174
175     return $order;
176   }
177
178   function get_order_ids_by_state($state_mask) {
179     $order_ids = array();
180     $dbh = Propel::getConnection();
181     $sth = $dbh->prepare("select * from OrderState o where updated=(select max(updated) from OrderState where order_id=o.order_id) and state & $state_mask");
182     $sth->execute();
183     $order_states = OrderStatePeer::populateObjects($sth);
184     foreach ($order_states as $order_state) $order_ids[] = $order_state->getOrderId();
185     return $order_ids;
186   }
187
188   function get_beneficiary_orders($contact, $state_mask = null) {
189     $q = new OrderQuery;
190     $q->filterByBeneficiaryId($contact->getId());
191     if ($state_mask) $q->filterById(get_order_ids_by_state($state_mask));
192     return $q->orderByDate()->find();
193   }
194
195   function get_requester_orders($contact, $state_mask = null) {
196     $q = new OrderQuery;
197     $q->filterByRequesterId($contact->getId());
198     if ($state_mask) $q->filterById(get_order_ids_by_state($state_mask));
199     return $q->orderByDate()->find();
200   }
201
202   function get_contact_orders($contact, $state_mask = null) {
203     $q = new OrderQuery;
204     $q->filterByBeneficiaryId($contact->getId())->_or()->filterByRequesterId($contact->getId());
205     if ($state_mask) $q->filterById(get_order_ids_by_state($state_mask));
206     return $q->orderByDate()->find();
207   }
208
209   function get_user_by_contact_id($id, $verbose = true) {
210     $q = new UserQuery;
211     $user = $q->findOneByContactId($id);
212
213     if (! $q->count()) {
214       if ($verbose) echo "<p>No such user!</p>\n";
215       return null;
216     }
217
218     return $user;
219   }
220
221   function get_city_displayname($city) {
222     return $city->getName() . ", " . $city->getPostcodeArea();
223   }
224
225   function get_area_displayname($area) {
226     return $area->getName() . " in " . get_city_displayname(CityQuery::create()->findOneById($area->getCityId()));
227   }
228
229   function get_donation_displayname($donation) {
230     return sprintf("%0.2fkg on %s", $donation->getQuantity() / 1000, $donation->getDate());
231   }
232
233   function get_order_parcel_string($order) {
234     global $parcel_sizes, $parcel_contents;
235
236     $parcel_size = null;
237     for ($i = 0 ; $i < count($parcel_sizes); $i++) {
238       if ($order->getParcel() & (1 << $i)) {
239         $parcel_size = $parcel_sizes[$i];
240         break;
241       }
242     }
243
244     $selected = array();
245     for ($i = count($parcel_sizes); $i < count($parcel_contents); $i++) {
246       if ($order->getParcel() & (1 << $i)) $selected[] = $parcel_contents[$i];
247     }
248
249     $ret = implode(": ", array($parcel_size, implode(", ", $selected)));
250     $ret = preg_replace('/^: /', '', $ret);
251     $ret = preg_replace('/: $/', '', $ret);
252
253     return $ret;
254   }
255
256   function get_order_displayname($order) {
257     return sprintf("<span class=\"small\">%s</span> on %s", get_order_parcel_string($order), $order->getDate());
258   }
259
260   function get_order_state_string($order_state = null) {
261     global $states;
262
263     if (is_null($order_state)) return null;
264
265     for ($i = 0; $i < count($states); $i++) {
266       if ($order_state->getState() & (1 << $i)) {
267         return $states[$i];
268       }
269     }
270
271     return "unknown";
272   }
273
274   function get_order_state($order) {
275     $q = new OrderStateQuery();
276     return $q->filterByOrderId($order->getId())->orderByUpdated('desc')->findOne();
277   }
278
279   function get_order_summary($order) {
280     $ret = "Order " . $order->getStrongLink($order->getId()) . ": " . get_order_displayname($order);
281
282     if (check_admin(1)) $ret .= " " . $order->getDeleteLink();
283
284     /* XXX: Should pull from query. */
285     $q = new ContactQuery;
286     $contact = $q->findOneById($order->getRequesterId());
287     if ($contact) {
288       $ret .= " referred by " . $contact->getLink();
289       $area = get_contact_area($contact);
290       if ($area) $ret .= " in " . $area->getLink();
291     }
292
293     $q = new ContactQuery;
294     $contact = $q->findOneById($order->getBeneficiaryId());
295     if ($contact) {
296       $ret .= " for " . $contact->getLink();
297       $area = get_contact_area($contact);
298       if ($area) $ret .= " in " . $area->getLink();
299     }
300
301     if ($order->getHubId()) {
302       $q = new HubQuery;
303       $hub = $q->findOneById($order->getHubId());
304       if ($hub) $ret .= " to hub " . $hub->getLink();
305       $area = get_hub_area($hub);
306       if ($area) $ret .= " in " . $area->getLink();
307     }
308
309     return $ret;
310   }
311
312   function get_address_area($address) {
313     $q = new AreaQuery;
314     return $q->findOneById($address->getAreaId());
315   }
316
317   function get_contact_address($contact) {
318     $q = new AddressQuery;
319     return $q->findOneById($contact->getAddressId());
320   }
321
322   function get_contact_area($contact) {
323     $address = get_contact_address($contact);
324     if (! $address) return null;
325
326     return get_address_area($address);
327   }
328
329   function get_contact_city($contact) {
330     $area = get_contact_area($contact);
331     if (! $area) return null;
332
333     return get_area_city($area);
334   }
335
336   /* Parcel strings are the same so this can work. */
337   function get_contact_parcel_string($contact) {
338     return get_order_parcel_string($contact);
339   }
340
341   /* Hub and Contact are similar enough that this can work. */
342   function get_hub_address($hub) {
343     return get_contact_address($hub);
344   }
345
346   /* Hub and Contact are similar enough that this can work. */
347   function get_hub_area($hub) {
348     return get_contact_area($hub);
349   }
350
351   /* Hub and Contact are similar enough that this can work. */
352   function get_hub_city($hub) {
353     return get_contact_city($hub);
354   }
355
356   function get_area_contacts($area_id = null, $role = null) {
357     $q = new ContactQuery;
358     if (isset($area_id)) $q->useAddressQuery()->filterByAreaId($area_id)->endUse();
359     if (isset($role)) $q->where("role & $role");
360     return $q->orderByDisplayname()->find();
361   }
362
363   function get_area_requesters($area_id = null) {
364     return get_area_contacts($area_id, $GLOBALS['ROLE_REQUESTER']);
365   }
366
367   function get_area_beneficiaries($area_id = null) {
368     return get_area_contacts($area_id, $GLOBALS['ROLE_BENEFICIARY']);
369   }
370
371   function get_area_donors($area_id = null) {
372     return get_area_contacts($area_id, $GLOBALS['ROLE_DONOR']);
373   }
374
375   function get_city_contacts($city_id = null, $role = null) {
376     /* XXX */
377     $area_ids = array();
378     $areas = get_city_areas($city_id);
379     foreach ($areas as $area) $area_ids[] = $area->getId();
380     return get_area_contacts($area_ids, $role);
381   }
382
383   function get_city_requesters($city_id = null) {
384     return get_city_contacts($city_id, $GLOBALS['ROLE_REQUESTER']);
385   }
386
387   function get_city_beneficiaries($city_id = null) {
388     return get_city_contacts($city_id, $GLOBALS['ROLE_BENEFICIARY']);
389   }
390
391   function get_city_donors($city_id = null) {
392     return get_city_contacts($city_id, $GLOBALS['ROLE_DONOR']);
393   }
394
395   function get_city_drivers($city_id = null) {
396     return get_city_contacts($city_id, $GLOBALS['ROLE_DRIVER']);
397   }
398
399   function get_role_string($object, $roles) {
400     $role = $object->getRole();
401
402     $selected = array();
403
404     for ($i =0; $i < count($roles); $i++) {
405       if ($role & (1 << $i)) $selected[] = $roles[$i];
406     }
407
408     return implode(", ", $selected);
409   }
410
411   function get_contact_role_string($contact) {
412     return get_role_string($contact, $GLOBALS['contact_roles']);
413   }
414
415   function get_hub_role_string($hub) {
416     return get_role_string($hub, $GLOBALS['hub_roles']);
417   }
418
419   function show_role_form($role, $roles) {
420     for ($i = 0; $i < count($roles); $i++) {
421       echo " <input type=\"checkbox\" name=\"role_$i\"";
422       if ($role & (1 << $i)) echo " checked";
423       echo ">$roles[$i]\n";
424     }
425   }
426
427   function get_area_hubs($area_id = null) {
428     $q = new HubQuery;
429     if (isset($area_id)) $q->useAddressQuery()->filterByAreaId($area_id)->endUse();
430     return $q->orderByDisplayname()->find();
431   }
432
433   function get_city_areas($city_id = null) {
434     $q = new AreaQuery;
435     $q->join("City")->orderBy("City.Name");
436     if (isset($city_id)) $q->filterByCityId($city_id);
437     return $q->orderByName()->find();
438   }
439
440   function get_city_areas_with_contacts($city_id = null, $role = null) {
441     $q = new AreaQuery;
442     $q->join("City")->orderBy("City.Name");
443     if (isset($city_id)) $q->filterByCityId($city_id);
444     /* XXX */
445     if (isset($role)) $q->useAddressQuery()->join("Contact")->useContactQuery()->where("role & $role")->endUse()->endUse();
446     else $q->useAddressQuery()->join("Contact")->endUse();
447     return $q->orderByName()->distinct()->find();
448   }
449
450   function get_city_areas_with_hubs($city_id = null) {
451     $q = new AreaQuery;
452     $q->join("City")->orderBy("City.Name");
453     if (isset($city_id)) $q->filterByCityId($city_id);
454     $q->useAddressQuery()->join("Hub")->endUse();
455     return $q->orderByName()->distinct()->find();
456   }
457
458   function get_city_hubs($city_id = null) {
459     $q = new HubQuery;
460     if (isset($city_id)) $q->useAddressQuery()->useAreaQuery()->filterByCityId($city_id)->endUse()->endUse();
461     return $q->orderByDisplayname()->find();
462   }
463
464   function iso8601_to_ymd($iso8601) {
465     return split("-", $iso8601);
466   }
467
468   function ymd_to_iso8601($name) {
469     $y = $_POST[$name . "_y"];
470     if (! $y) return null;
471     $m = $_POST[$name . "_m"];
472     if (! $m) $m = 1;
473     $d = $_POST[$name . "_d"];
474     if (! $d) $d = 1;
475     return sprintf("%04d-%02d-%02d", $y, $m, $d);
476   }
477
478   function show_date_form($name, $date = null) {
479     $past = 60;
480     $future = 60;
481     echo "<select name=\"$name\">\n";
482     $now = date('Y-m-d', time());
483     list($y, $m, $d) = explode('-', $now);
484     $today = mktime(0, 0, 0, $m, $d, $y);
485     if (isset($date)) {
486       list($y, $m, $d) = explode('-', $date);
487       $then = mktime(0, 0, 0, $m, $d, $y);
488       if ($then < $today - 86400 * $past || $then > $today + 86400 * $future) {
489         option($name, $date, date('l j F Y', $then), $date);
490       }
491     }
492     else $date = $now;
493     for ($i = -$past; $i < $future; $i++) {
494       $then = $today + 86400 * $i;
495       option($name, date('Y-m-d', $then), date('l j F Y', $then), $date);
496     }
497     echo "</select>\n";
498     return;
499     if (! isset($date)) $date = date('Y-m-d');
500     list($y, $m, $d) = iso8601_to_ymd($date);
501
502     echo "Year: <input name=\"$name" . "_y\" value=\"$y\" size=4 maxlen=4> ";
503     echo "Month: <input name=\"$name" . "_m\" value=\"$m\" size=2 maxlen=2> ";
504     echo "Day: <input name=\"$name" . "_d\" value=\"$d\" size=2 maxlen=2> ";
505   }
506
507   function get_small_link() {
508     /* Args are <alt text>, <format>, [<stuff> ...] */
509     $args = func_get_args();
510     $html = htmlspecialchars(array_shift($args));
511     $url = array_shift($args);
512     return vsprintf("<a class=\"small noprint\" href=\"$url\">$html</a>\n", $args);
513   }
514
515   function small_link() {
516     echo call_user_func_array("get_small_link", func_get_args());
517   }
518
519   include_once("$lib_root/admin.php");
520   include_once("$lib_root/forms.php");
521
522 ?>