Fix/lint

www/docs/alert/index.php

@@ -93,11 +93,6 @@ function check_input($details) {
     if (!ctype_digit($details['pid']) && $details['pid'] != '') {
         $errors['pid'] = 'Please choose a valid person';
     }
-    /*
-     * if (!$details['keyword']) {
-     *     $errors['keyword'] = 'Please enter a search term';
-     * }
-     */
 
     if ((get_http_var('submitted') || get_http_var('only')) && !$details['pid'] && !$details['keyword']) {
         $errors['keyword'] = 'Please choose a person and/or enter a keyword';
@@ -118,6 +113,7 @@ function add_alert($details) {
     // Instantiate an instance of ALERT.
     $ALERT = new ALERT();
 
+    // auth_verify_with_shared_secret is in phplib/auth.php. It checks the signature of the request using a shared secret, and returns true if the signature is correct.
     $external_auth = auth_verify_with_shared_secret($details['email'], OPTION_AUTH_SHARED_SECRET, get_http_var('sign'));
     if ($external_auth) {
         $site = get_http_var('site');
@@ -191,8 +187,8 @@ function add_alert($details) {
     $PAGE->page_end($extra);
 }
 
-/*  This function creates the form for displaying an alert, prompts the user for input and creates
- *  the alert when submitted.
+/* This function creates the form for displaying an alert, prompts the user for input and creates
+ * the alert when submitted.
  */
 
 /**
@@ -206,7 +202,7 @@ function display_form($details = [], $errors = []) {
 
     <p>This page allows you to request an email alert from OpenAustralia.org.</p>
 
-    <? if (!get_http_var('only')) { ?>
+    <?php if (!get_http_var('only')) { ?>
         <ul>
             <li>To receive an alert <strong>every time a particular person appears</strong>,
                 select their name from the drop-down list and
@@ -226,22 +222,27 @@ function display_form($details = [], $errors = []) {
 
         <p>Please note that you should only enter one topic per alert - if you wish to receive alerts on more than one topic, or
             for more than one person, simply fill in this form as many times as you need.</p>
-    <? } ?>
+    <?php
+    }
+    ?>
 
     <form method="post" action="<?php echo $ACTIONURL->generate(); ?>">
-
-        <?php if (!$THEUSER->loggedin()) {
+        <?php
+        if (!$THEUSER->loggedin()) {
             if (isset($errors["email"]) && (get_http_var('submitted') || get_http_var('only'))) {
                 $PAGE->error_message($errors["email"]);
             }
             ?>
             <div class="row">
                 <span class="label"><label for="email">Your email address:</label></span>
-                <span class="formw"><input type="text" name="email" id="email" value="<?php if (isset($details["email"])) {
-                    echo htmlentities($details["email"]);
-                } ?>" maxlength="255" size="30" class="form"></span>
+                <span class="formw"><input type="text" name="email" id="email" value="<?php
+                    if (isset($details["email"])) {
+                            echo htmlentities($details["email"]);
+                    } ?>" maxlength="255" size="30" class="form"></span>
             </div>
-        <?php }
+        <?php
+        }
+
         if (!get_http_var('only') || !$details['keyword']) {
             if (isset($errors['pid'])) {
                 $PAGE->error_message($errors['pid']);
@@ -254,19 +255,20 @@ function display_form($details = [], $errors = []) {
                     $MEMBER = new MEMBER(['person_id' => $details['pid']]);
                     print $MEMBER->full_name();
                     print '<input type="hidden" name="pid" value="' . htmlspecialchars($details['pid']) . '">';
-                }
-                else { ?><select name="pid">
-                            <option value="Any">Any Representative or Senator</option>
-                            <?php
-                            // Get a list of MPs/Lords for displaying in the form using the PEOPLE class.
-                            $LIST = new PEOPLE();
-                            $args['order'] = 'last_name';
-                            if ($details['pid'])
-                                $args['pid'] = $details['pid'];
-                            $LIST->listoptions($args);
-                            ?>
-                        </select>
-                    <?php } ?>
+                } else { ?>
+                    <select name="pid">
+                        <option value="Any">Any Representative or Senator</option>
+                        <?php
+                        // Get a list of MPs/Lords for displaying in the form using the PEOPLE class.
+                        $LIST = new PEOPLE();
+                        $args['order'] = 'last_name';
+                        if ($details['pid']) {
+                            $args['pid'] = $details['pid'];
+                        }
+                        $LIST->listoptions($args);
+                        ?>
+                    </select>
+                <?php } ?>
                 </span>
             </div>
         <?php }
@@ -277,7 +279,8 @@ function display_form($details = [], $errors = []) {
             ?>
             <div class="row">
                 <span class="label"><label for="keyword">Word or phrase you wish to receive alerts for:</label></span>
-                <span class="formw"><input type="text" name="keyword" id="keyword" value="<?php if ($details['keyword']) {
+                <span class="formw"><input type="text" name="keyword" id="keyword" value="<?php
+                if ($details['keyword']) {
                     echo htmlentities($details['keyword']);
                 } ?>" maxlength="255" size="30" class="form"></span>
             </div>

www/docs/api/api_convertURL.php

@@ -23,10 +23,10 @@ function api_convertURL_front() {
     </dl>
 
     <h4>Example Response</h4>
-    <pre>{
-                    gid : "uk.org.publicwhip/debate/2006-07-11a.1352.2",
-                    url : "http://www.openaustralia.org/debates/?id=2006-07-11a.1311.0#g1352.2"
-                }</pre>
+    <code>{
+        gid : "uk.org.publicwhip/debate/2006-07-11a.1352.2",
+        url : "http://www.openaustralia.org/debates/?id=2006-07-11a.1311.0#g1352.2"
+    }</code>
 
     <h4>Example Use</h4>
     <p>This probably counts as "AJAX", though it doesn't use XMLHTTP, asynchronicity, or XML, only cross-site JavaScript...

www/docs/api/api_functions.php

@@ -129,7 +129,7 @@ function api_log_call($key) {
     if ($key == 'DOCS') {
         return;
     }
-    $ip = $_SERVER['REMOTE_ADDR'];
+    $ip = ip_address();
     $query = $_SERVER['REQUEST_URI'];
     $query = preg_replace('#key=[A-Za-z0-9]+&?#', '', $query);
     $db = new ParlDB();
@@ -349,9 +349,9 @@ function api_output_js($v, $level = 0) {
         return "null";
     } elseif (is_string($v)) {
         return '"' . str_replace(
-            ["\\", '"', "\n", "\t", "\r"],
-            ["\\\\", '\\"', '\\n', '\\t', '\\r'],
-            $v
+            search: ["\\", '"', "\n", "\t", "\r"],
+            replace: ["\\\\", '\\"', '\\n', '\\t', '\\r'],
+            subject: $v
         ) . '"';
     } elseif (is_bool($v)) {
         return $v ? 'true' : 'false';

www/docs/api/api_getCommittee.php

@@ -22,33 +22,37 @@ function api_getCommittee_front() {
 
     <h4>Example responses</h4>
 
-    <pre>{ "committees" : [
-                        { "name" : "Scottish Affairs Committee" },
-                        { "name" : "Northern Ireland Affairs Committee" },
-                        { "name" : "Home Affairs Committee" },
-                        { "name" : "Constitutional Affairs Committee" },
-                        { "name" : "Environment, Food and Rural Affairs Committee" },
-                        { "name" : "Foreign Affairs Committee" },
-                        { "name" : "Welsh Affairs Committee" }
-                    ] }</pre>
+    <pre>
+        { "committees" : [
+            { "name" : "Scottish Affairs Committee" },
+            { "name" : "Northern Ireland Affairs Committee" },
+            { "name" : "Home Affairs Committee" },
+            { "name" : "Constitutional Affairs Committee" },
+            { "name" : "Environment, Food and Rural Affairs Committee" },
+            { "name" : "Foreign Affairs Committee" },
+            { "name" : "Welsh Affairs Committee" }
+        ] }
+    </pre>
 
-    <pre>{
-                        "committee" : "Health Committee",
-                        "members" : [
-                        { "person_id" : "10009", "name" : "David Amess" },
-                        { "person_id" : "10018", "name" : "Charlotte Atkins" },
-                        { "person_id" : "10176", "name" : "Jim Dowd" },
-                        { "person_id" : "11603", "name" : "Anne Milton" },
-                        { "person_id" : "10455", "name" : "Doug Naysmith" },
-                        { "person_id" : "11626", "name" : "Michael Penning" },
-                        { "person_id" : "10571", "name" : "Howard Stoate" },
-                        { "person_id" : "11275", "name" : "Richard Taylor" },
-                        { "person_id" : "10027", "name" : "Kevin Barron", "position" : "Chairman" },
-                        { "person_id" : "10089", "name" : "Ronnie Campbell" },
-                        { "person_id" : "10677", "name" : "Sandra Gidley" }
-                      ]
-                    }
-                      <?php
+    <pre>
+        {
+            "committee" : "Health Committee",
+            "members" : [
+            { "person_id" : "10009", "name" : "David Amess" },
+            { "person_id" : "10018", "name" : "Charlotte Atkins" },
+            { "person_id" : "10176", "name" : "Jim Dowd" },
+            { "person_id" : "11603", "name" : "Anne Milton" },
+            { "person_id" : "10455", "name" : "Doug Naysmith" },
+            { "person_id" : "11626", "name" : "Michael Penning" },
+            { "person_id" : "10571", "name" : "Howard Stoate" },
+            { "person_id" : "11275", "name" : "Richard Taylor" },
+            { "person_id" : "10027", "name" : "Kevin Barron", "position" : "Chairman" },
+            { "person_id" : "10089", "name" : "Ronnie Campbell" },
+            { "person_id" : "10677", "name" : "Sandra Gidley" }
+            ]
+        }
+    </pre>
+            <?php
 }
 
 /**

www/docs/api/api_getConstituencies.php

@@ -26,11 +26,11 @@ function api_getConstituencies_front() {
 
     <h4>Example Response</h4>
     <pre>[
-                { name : "Warringah" },
-                { name : "Lyons" },
-                { name : "Fairfax" },
-                ...
-            ]</pre>
+                    { name : "Warringah" },
+                    { name : "Lyons" },
+                    { name : "Fairfax" },
+                    ...
+                ]</pre>
 
     <?php
 }
@@ -96,11 +96,11 @@ function api_getConstituencies($date = 'now()') {
     api_output($output);
 }
 
-/* R_e
+/* RADIUS_OF_EARTH
  * Radius of the earth, in km. This is something like 6372.8 km:
- *  http://en.wikipedia.org/wiki/Earth_radius
+ * http://en.wikipedia.org/wiki/Earth_radius
  */
-define('R_e', 6372.8);
+define('RADIUS_OF_EARTH', 6372.8);
 
 /**
  *
@@ -126,18 +126,18 @@ function _api_getConstituencies_latitude($lat, $lon, $d) {
         if (!isset($data['centre_lat']) || !isset($data['centre_lon'])) {
             continue;
         }
-        $distance = R_e * acos(
+        $distance = RADIUS_OF_EARTH * acos(
             sin(deg2rad($lat)) * sin(deg2rad($data['centre_lat']))
             + cos(deg2rad($lat)) * cos(deg2rad($data['centre_lat']))
             * cos(deg2rad($lon - $data['centre_lon']))
         );
         if (
-            deg2rad($data['centre_lat']) > deg2rad($lat) - ($d / R_e)
-            && deg2rad($data['centre_lat']) < deg2rad($lat) + ($d / R_e)
+            deg2rad($data['centre_lat']) > deg2rad($lat) - ($d / RADIUS_OF_EARTH)
+            && deg2rad($data['centre_lat']) < deg2rad($lat) + ($d / RADIUS_OF_EARTH)
             // Case where search pt is near pole.
-            && (abs(deg2rad($lat)) + ($d / R_e) > M_PI_2
+            && (abs(deg2rad($lat)) + ($d / RADIUS_OF_EARTH) > M_PI_2
                 || _api_angle_between(deg2rad($data['centre_lon']), deg2rad($lon))
-                < $d / (R_e * cos(deg2rad($lat + $d / R_e))))
+                < $d / (RADIUS_OF_EARTH * cos(deg2rad($lat + $d / RADIUS_OF_EARTH))))
             && $distance < $d
         ) {
             $out[] = array_merge(

www/docs/api/api_getDebates.php

@@ -36,43 +36,43 @@ function api_getDebates_front() {
 
     <h4>Example Response (search)</h4>
     <pre>{
-        "info" : {
-            "s" : "cows section:lords",
-            "results_per_page" : 20,
-            "page" : 1,
-            "total_results" : 24,
-            "first_result" : 1
-        },
-        "searchdescription" : "containing the word 'cows' in Senate debates",
-        "rows" : [{
-            "gid" : "2009-02-11.70.21",
-            "hdate" : "2009-02-11",
-            "htype" : "12",
-            "major" : "101",
-            "section_id" : "5316",
-            "subsection_id" : "5317",
-            "relevance" : 99,
-            "speaker_id" : "100114",
-            "hpos" : "221",
-            "body" : "Shut the door. I can hear the <span class=\"hi\">cows</span> coming home!",
-            "listurl" : "/senate/?id=2009-02-11.66.2&amp;s=cows+section%3Alords#g70.21",
-            "speaker" : {
-                "member_id" : "100114",
-                "title" : "",
-                "first_name" : "Barnaby",
-                "last_name" : "Joyce",
-                "house" : "2",
-                "constituency" : "Queensland",
-                "party" : "National Party",
-                "person_id" : "10350",
-                "url" : "/senator/?m=100114"
+            "info" : {
+                "s" : "cows section:lords",
+                "results_per_page" : 20,
+                "page" : 1,
+                "total_results" : 24,
+                "first_result" : 1
             },
-            "parent" : {
-                "body" : "Appropriation (Nation Building and Jobs) Bill (No. 1) 2008-2009; Appropriation (Nation Building and Jobs) Bill (No. 2) 2008-2009; Household Stimulus Package Bill 2009; Tax Bonus for Working Australians Bill 2009; Tax Bonus for Working Australians (Consequential Amendments) Bill 2009; Commonwealth Inscribed Stock Amendment Bill 2009: In Committee"
-            }
-        }]
-    }
-    </pre>
+            "searchdescription" : "containing the word 'cows' in Senate debates",
+            "rows" : [{
+                "gid" : "2009-02-11.70.21",
+                "hdate" : "2009-02-11",
+                "htype" : "12",
+                "major" : "101",
+                "section_id" : "5316",
+                "subsection_id" : "5317",
+                "relevance" : 99,
+                "speaker_id" : "100114",
+                "hpos" : "221",
+                "body" : "Shut the door. I can hear the <span class=\"hi\">cows</span> coming home!",
+                "listurl" : "/senate/?id=2009-02-11.66.2&amp;s=cows+section%3Alords#g70.21",
+                "speaker" : {
+                    "member_id" : "100114",
+                    "title" : "",
+                    "first_name" : "Barnaby",
+                    "last_name" : "Joyce",
+                    "house" : "2",
+                    "constituency" : "Queensland",
+                    "party" : "National Party",
+                    "person_id" : "10350",
+                    "url" : "/senator/?m=100114"
+                },
+                "parent" : {
+                    "body" : "Appropriation (Nation Building and Jobs) Bill (No. 1) 2008-2009; Appropriation (Nation Building and Jobs) Bill (No. 2) 2008-2009; Household Stimulus Package Bill 2009; Tax Bonus for Working Australians Bill 2009; Tax Bonus for Working Australians (Consequential Amendments) Bill 2009; Commonwealth Inscribed Stock Amendment Bill 2009: In Committee"
+                }
+            }]
+        }
+        </pre>
     <?php
 }
 

www/docs/api/api_getGeometry.php

@@ -27,17 +27,17 @@ function api_getGeometry_front() {
 
     <h4>Example Response</h4>
     <pre>
-    &lt;twfy&gt;
-        &lt;centre_lat&gt;52.204105461821&lt;/centre_lat&gt;
-        &lt;centre_lon&gt;0.12659823548615&lt;/centre_lon&gt;
-        &lt;area&gt;28775860&lt;/area&gt;
-        &lt;min_lat&gt;52.171543612943&lt;/min_lat&gt;
-        &lt;max_lat&gt;52.236635567414&lt;/max_lat&gt;
-        &lt;min_lon&gt;0.066543287124126&lt;/min_lon&gt;
-        &lt;max_lon&gt;0.18674084465674&lt;/max_lon&gt;
-        &lt;parts&gt;1&lt;/parts&gt;
-    &lt;/twfy&gt;
-    </pre>
+        &lt;twfy&gt;
+            &lt;centre_lat&gt;52.204105461821&lt;/centre_lat&gt;
+            &lt;centre_lon&gt;0.12659823548615&lt;/centre_lon&gt;
+            &lt;area&gt;28775860&lt;/area&gt;
+            &lt;min_lat&gt;52.171543612943&lt;/min_lat&gt;
+            &lt;max_lat&gt;52.236635567414&lt;/max_lat&gt;
+            &lt;min_lon&gt;0.066543287124126&lt;/min_lon&gt;
+            &lt;max_lon&gt;0.18674084465674&lt;/max_lon&gt;
+            &lt;parts&gt;1&lt;/parts&gt;
+        &lt;/twfy&gt;
+        </pre>
     <?php
 }