Merge pull request #13 from jxmot/20220421-issues

jxmot · web-flow · commit b766e85f09b9 · 2022-04-22T09:37:48.000-05:00
Merge issue changes
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+<p style="text-align:center">
+If this repository has helped you please consider a donation to help keep this project going. Thank You!
+<br><br>
+<a href="https://www.paypal.me/jxmot" target="_blank"><img src=https://img.shields.io/badge/Contribute-PayPal.me-3b29ff.svg></a>
+</p>
+
 # Markdown Hit Counter
 
 This counter is intended for use in GitHub README markdown files. It has the following features:
@@ -13,7 +19,7 @@ This counter is intended for use in GitHub README markdown files. It has the fol
 
 You will need:
 
-* A HTTP server, not HTTPS. It has not been tested with HTTPS. **If you get it to work with HTTPS please let me know and I will update this file.**
+* A web server, HTTP or HTTPS should be ok.
 * The server needs PHP >5.6.
 * You will need access to your server to copy files and create a folder.
 
@@ -160,10 +166,40 @@ It is possible to retrieve the counter data for a single counter or for all of t
 **Return data for a specific counter -**
 
 ```
-GET http[s]://your-server/path-to-file/mdcountdata.php?id=testtest
+GET http[s]://your-server/path-to-file/mdcountdata.php?id=sensornet
+```
+
+The data is returned in JSON - 
+
+```
+[
+    {
+        "id": "sensornet",
+        "data": {
+            "count": 30,
+            "time": 1616458038,
+            "dtime": [
+                "20210322",
+                "190718"
+            ]
+        }
+    }
+]
 ```
 
 
+**Return just the count data for a specific counter -**
+
+```
+GET http[s]://your-server/path-to-file/mdcountdata.php?id=sensornet&count
+```
+
+A single value is returned, no JSON formatting - 
+
+```
+30
+```
+
 **Return data for all counters -**
 
 ```
@@ -254,15 +290,18 @@ GET http[s]://your-server/path-to-file/mdcountdata.php?id=BLAH
 
 The following files are used in report generation and viewing:
 
-* `mdreport.php` - Retrieves the counter data and renders a Bootstrap 4.x table.
-  * `mdreport.css` - Additional required CSS for the table
+* `mdreport.php` - Retrieves the counter data and renders a Bootstrap 4.x table
+  * `mdhcreport.css` - Additional required CSS for the table
+  * `embedreport.css` - CSS required for an embedded report
+  * `reporthead.html` - For non-embedded reports, this contains the page title and table heading
+  * `reportcaption.html` - For non-embedded reports, this contains the table caption
   * `mdreport-th.txt` - Column heading text
-  * `stddefines.php` - A collection of `define()` that make a number of PHP `$_SERVER[]` values available to the application. It contains components used for creating URLs to resources.
-* `report.html` - The minimum required HTML/CSS and JavaScript/jQuery to render and display the table.
+  * `stddefines.php` - A collection of `define()` that make a number of PHP `$_SERVER[]` values available to the application. It contains components used for creating URLs to resources
+* `report.html` - The minimum required HTML/CSS and JavaScript/jQuery to render and display the table
 
 **Retrieving the Report -**
 
-The code that retreives the report and handles clicks on the column headings is contained in `report.html`. 
+The code that retreives the report and handles clicks on the column headings is contained in `report.html`. The necessary CSS can be found in `mdhcreport.css`.
 
 ```
 <body>
@@ -338,9 +377,9 @@ document.addEventListener("DOMContentLoaded", () => {
 </body>
 ```
 
-**Sample Report Screen Shot -**
+**Sample Report Screen Shot - (via `report.html`)**
 
-<img src="./mdimg/report_sshot.png" style="border: 2px dashed">
+<img src="./mdimg/report_sshot.png" style="border: 2px dashed;max-width:50%;">
 
 The "Hit Count", "Repository" and "Last Counted" headings can be clicked to select sorting criteria and direction (*ascending vs descending*). When a column heading is clicked the report caption will change to reflect the choice.
 
@@ -350,7 +389,23 @@ The "Hit Count", "Repository" and "Last Counted" headings can be clicked to sele
 * The links in the "Repository" column are built from the IDs found in `counters.json`. The ID text I used there is the *name of the repository* that the counter is intended for. The corresponding counter data files are named `repo-name`**`_counter.json`**.
 * When the report is viewed the data shown is *current*. 
 * If the "Last Counted" column date and time seem to be incorrect then the time zone may need to be changed. Edit the `timezone.json` file to match your time zone.
- 
+
+## "Embedded" Report
+
+It is possible to retreive counter data without using `report.html`. The purpose is to *embed* the table in another page and to be able to apply some alternative CSS.
+
+To retrieve it - 
+
+```
+GET http[s]://your-server/path-to-file/mdreport.php?tsort=d&limit=5&embed
+```
+
+The response is going to contain some CSS for the table, and *just* the table itself. You can use a browser and go to `http[s]://your-server/path-to-file/mdreport.php?tsort=d&limit=5&embed`. You will see something like this- 
+
+<img src="./mdimg/report_embed_sshot.png" style="border: 2px dashed;max-width:50%;">
+
+**NOTE:** The table is not sortable like the one rendered with `report.html`. 
+
 ## Other Uses
 
 You could count just about anything. All you need is to do a GET of `mdcount.php` with a proper query and you got a counter!
@@ -359,7 +414,7 @@ You could count just about anything. All you need is to do a GET of `mdcount.php
 
 This started out as an interesting afternoon project. I created it because I could not find *exactly* what I needed in the many hit counters out there.
 
-And this project has evolved since then with the addition (and changes) of JSON formatted counter files, and sorted counter data retrieval.
+And this project has evolved since then with the addition (and changes) of JSON formatted counter files, and sorted counter data retrieval. And the latest change was adding a 5th column to contain some GitHub statistics. 
 
 ---
 <img src="http://webexperiment.info/extcounter/mdcount.php?id=markdown-hitcounter">
diff --git a/embedreport.css b/embedreport.css
@@ -0,0 +1,21 @@
+/* embedreport.css */
+.hit-table {
+  border-collapse: collapse;
+}
+
+.hit-table thead {
+    border-bottom: 3px solid black;
+}
+
+.hit-table tr {
+    border-bottom: 1px solid black;
+}
+/*
+    Bootstrap classes:
+
+        table-responsive
+        table 
+        table-sm
+
+    Not needed when the report is embedded.
+*/
diff --git a/mdcountdata.php b/mdcountdata.php
@@ -157,13 +157,16 @@ function idsort($sort, $out, $limit = null) {
     $isort = (isset($queries['isort']) ? strtolower($queries['isort']) : null);
     // for sorts, limit number of counters returned
     $limit = (isset($queries['limit']) ? $queries['limit'] : null);
+    // if $count is true then only the count value will be returned
+    $count = (isset($queries['count']) ? true : false);
 } else {
     // set as needed for testing
     $id    = null;
     $csort = 'a';
     $tsort = null;
     $isort = null;
     $limit = 2;
+    $count = false;
 }
 
 // get the valid counter ID list
@@ -185,8 +188,12 @@ function idsort($sort, $out, $limit = null) {
             // would get that big.
             $json = fgets($filecnt,128);
             fclose($filecnt);
-            //$result = '['.$json.']';
-            $result = '[{"id":"'.$id.'","data":'.$json.'}]';
+            if($count === false) {
+                $result = '[{"id":"'.$id.'","data":'.$json.'}]';
+            } else {
+                $tmp = json_decode($json);
+                $result = $tmp->{'count'};
+            }
         } else {
             $result = '[{"error":true,"msg":"file ['.$cntfile.'] does not exist"}]';
         }
diff --git a/mdhcreport.css b/mdhcreport.css
@@ -1,4 +1,4 @@
-
+/* mdhcreport.css */
 div.table-container {
     max-width:30%;
     margin:auto;
@@ -119,3 +119,32 @@ table.hit-table caption {
     background-color: rgba(189, 183, 137, 1);
     border-radius: 15px 50px;
 }
+
+.stats-cell {
+    background-color: lightgrey;
+}
+
+.stats-cell-stars {
+    margin: 0 0.15rem 0.15rem 0.15rem;
+}
+
+.stats-cell-forks {
+    margin: 0 0.15rem 0.15rem 0.15rem;
+}
+
+.stats-cell-watchers {
+    margin: 0 0.15rem 0.15rem 0.15rem;
+}
+
+.stats-cell-issues {
+    margin: 0 0.15rem 0.15rem 0.15rem;
+}
+
+.stats-cell-first {
+    margin-top: 0.25rem!important;
+}
+
+.stats-cell-last {
+    margin-bottom: 0.25rem!important;
+}
+
diff --git a/mdimg/report_embed_sshot.png b/mdimg/report_embed_sshot.png
diff --git a/mdimg/report_sshot.png b/mdimg/report_sshot.png
diff --git a/mdreport-th.txt b/mdreport-th.txt
@@ -1 +1 @@
-#,Views,Repository,Last Viewed
+#,Views,Repository,Last Viewed,Stats
diff --git a/mdreport.php b/mdreport.php
@@ -17,9 +17,6 @@ function tzone() {
 
 // check for debug/test mode
 if(!defined('_DEBUG') || _DEBUG === false) {
-
-//    $mdcountdata = THISSRVR.'/mdcountdata.php';
-
     // MUST be done like this for PHP files that are 'linked'
     $queries = array();
     if(QRYSTR !== null) {
@@ -33,15 +30,14 @@ function tzone() {
     $isort = (isset($queries['isort']) ? strtolower($queries['isort']) : null);
     // for sorts, limit number of counters returned
     $limit = (isset($queries['limit']) ? $queries['limit'] : null);
+    // if embed is true then there will be no report heading or table caption
+    $embed = (isset($queries['embed']) ? true : false);
 } else {
     // for testing the query string while _DEBUG is true
     if(QRYSTR !== null) {
         $q = QRYSTR;
         echo "<p>$q</p>\n";
     }
-
-//    $mdcountdata = THISSRVR.'/mdcountdata.php';
-
     // set as needed for testing
     $csort = 'd';
     $tsort = null;
@@ -52,7 +48,8 @@ function tzone() {
 $thfile = './mdreport-th.txt';
 $arrup = 'sort-arrow-up';
 $arrdn = 'sort-arrow-dn';
-$repohome = 'https://github.com/jxmot/';
+$owner = 'jxmot';
+$repohome = 'https://github.com/'.$owner.'/';
 $linktitle = 'Open Link in New Tab or Window';
 $thtitle = 'Click to select or to change the sorting order.';
 
@@ -74,27 +71,34 @@ function tzone() {
 ?>
 <style>
 <?php
-echo file_get_contents('./mdreport.css');
+echo file_get_contents('./mdhcreport.css');
+if($embed === true) echo file_get_contents('./embedreport.css');
 ?>
 </style>
 <div class="table-responsive table-container">
-    <p style="text-align:center!important;">
-        <br>
-        <strong>
-            This is a demonstration of the code found in 
-            <br>
-            <a href="https://github.com/jxmot/markdown-hitcounter" target="_blank" title="Open in new tab">markdown-hitcounter</a>.
-        </strong>
-    </p>
+<?php
+if($embed === false) include 'reporthead.html';
+?>
     <table id="hit-table" class="table table-sm hit-table">
         <thead>
             <tr>
 <?php
     for($ix = 0; $ix < count($thitems); $ix++) {
-        if($ix !== $sortidx) {   
-            echo '            <th'.($ix !== 0 ? ' id="hit-table-col'.$ix.'" title="'.$thtitle.'" class="orderhover" data-ix="'.$ix.'"' : '').'>'.$thitems[$ix].'</th>'."\n";
+        if($embed === false) {
+            if($ix !== $sortidx) {
+                // the last column is not sortable, this 
+                // is intentional. it's used as the "Stats"
+                // column and the data cannot be sorted.
+                if($ix === (count($thitems) - 1)) {
+                    echo '            <th'.($ix !== 0 ? ' id="hit-table-col'.$ix.'" title="" class="" data-ix="'.$ix.'"' : '').'>'.$thitems[$ix].'</th>'."\n";
+                } else {
+                    echo '            <th'.($ix !== 0 ? ' id="hit-table-col'.$ix.'" title="'.$thtitle.'" class="orderhover" data-ix="'.$ix.'"' : '').'>'.$thitems[$ix].'</th>'."\n";
+                }
+            } else {
+                echo '            <th id="hit-table-col'.$ix.'" title="'.$thtitle.'" class="orderhover" data-order="'.$sortdir.'" data-ix="'.$ix.'">'.$thitems[$ix].'<span id="hit-table-order'.$ix.'" data-order="'.$sortdir.'" data-ix="'.$ix.'" class="'.$dircss.'">&nbsp;</span></th>'."\n";
+            }
         } else {
-            echo '            <th id="hit-table-col'.$ix.'" title="'.$thtitle.'" class="orderhover" data-order="'.$sortdir.'" data-ix="'.$ix.'">'.$thitems[$ix].'<span id="hit-table-order'.$ix.'" data-order="'.$sortdir.'" data-ix="'.$ix.'" class="'.$dircss.'">&nbsp;</span></th>'."\n";
+            echo '            <th'.($ix !== 0 ? ' id="hit-table-col'.$ix.'" title="" class="" data-ix="'.$ix.'"' : '').'>'.$thitems[$ix].'</th>'."\n";
         }
     }
 ?>
@@ -185,14 +189,30 @@ function tzone() {
             $date = $counters[$ix]->data->dtime[0] . '<br>' . $counters[$ix]->data->dtime[1];
         }
 
-        echo "            <td>".$date."</td>\n";
-        echo "        </tr>\n";
+        echo "                <td>".$date."</td>\n";
+
+        echo "                <td>\n";
+        echo '                    <div class="stats-cell">' . "\n";
+        echo '                        <img class="stats-cell-stars stats-cell-first" src="https://img.shields.io/github/stars/'.$owner.'/'.$counters[$ix]->id.'">' . "\n";
+        echo "                        <br>\n";
+        echo '                        <img class="stats-cell-forks stats-cell-last" src="https://img.shields.io/github/forks/'.$owner.'/'.$counters[$ix]->id.'">' . "\n";
+// uncomment the next two lines to have the number of watchers
+// if this is the last badge then add the stats-cell-last class
+// and remove it above
+//        echo "                        <br>\n";
+//        echo '                        <img class="stats-cell-watchers" src="https://img.shields.io/github/watchers/'.$owner.'/'.$counters[$ix]->id.'">' . "\n";
+// uncomment the next two lines to have the issue count
+// if this is the last badge then add the stats-cell-last class
+// and remove it above
+//        echo "                        <br>\n";
+//        echo '                        <img class="stats-cell-issues" src="https://img.shields.io/github/issues/'.$owner.'/'.$counters[$ix]->id.'">' . "\n";
+        echo "                    </div>\n";
+        echo "                </td>\n";
+        echo "            </tr>\n";
     }
+
+    if($embed === false) include 'reportcaption.html';
 ?>
-            <!-- BS4 likes to render this on the bottom of the table, but we have CSS that
-                moves it to the top. 
-            -->
-            <caption><?php echo $tablecaption; ?></caption>
         </tbody>
     </table>
 </div>
diff --git a/reportcaption.html b/reportcaption.html
@@ -0,0 +1,4 @@
+            <!-- BS4 likes to render this on the bottom of the table, but we have CSS that
+                moves it to the top. 
+            -->
+            <caption><?php echo $tablecaption; ?></caption>
diff --git a/reporthead.html b/reporthead.html
@@ -0,0 +1,8 @@
+    <p style="text-align:center!important;">
+        <br>
+        <strong>
+            This is a demonstration of the code found in 
+            <br>
+            <a href="https://github.com/jxmot/markdown-hitcounter" target="_blank" title="Open in new tab">markdown-hitcounter</a>.
+        </strong>
+    </p>

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-#,Views,Repository,Last Viewed`
	`1`	`+#,Views,Repository,Last Viewed,Stats`