Add example summary script

scripts/README.md

@@ -2,6 +2,11 @@
 
 Due to the verboseness of the logs, a great deal of information can be gathered quite easily from the BDFR's logfiles. In this folder, there is a selection of scripts that parse these logs, scraping useful bits of information. Since the logfiles are recurring patterns of strings, it is a fairly simple matter to write scripts that utilise tools included on most Linux systems.
 
+  - [Script to extract all successfully downloaded IDs](#extract-all-successfully-downloaded-ids)
+  - [Script to extract all failed download IDs](#extract-all-failed-ids)
+  - [Timestamp conversion](#converting-bdfrv1-timestamps-to-bdfrv2-timestamps)
+  - [Printing summary statistics for a run](#printing-summary-statistics)
+
 ## Extract all Successfully Downloaded IDs
 
 This script is contained [here](extract_successful_ids.sh) and will result in a file that contains the IDs of everything that was successfully downloaded without an error. That is, a list will be created of submissions that, with the `--exclude-id-file` option, can be used so that the BDFR will not attempt to redownload these submissions/comments. This is likely to cause a performance increase, especially when the BDFR run finds many resources.
@@ -42,3 +47,23 @@ An example of the script being run on a Linux machine is the following:
 BDFRv2 uses an internationally recognised and standardised format for timestamps, namely ISO 8601. This is highly recommended due to the nature of using such a widespread and understood standard. However, the BDFRv1 does not use this standard. Due to this, if you've used the old timestamp in filenames or folders, the BDFR will no longer recognise them as the same file and potentially redownload duplicate resources.
 
 To prevent this, it is recommended that you rename existing files to ISO 8601 standard. This can be done using the [timestamp-converter](https://github.com/Serene-Arc/timestamp-converter) tool made for this purpose. Instructions specifically for the BDFR are available in that project.
+
+## Printing Summary Statistics
+
+A simple script has been included to print sumamry statistics for a run of the BDFR. This is mainly to showcase how easy it is to extract statistics from the logfiles. You can extend this quite easily. For example, you can print how often the Imgur module is used, or how many 404 errors there are in the last run, or which module has caused the most errors. The possibilities really are endless.
+
+```bash
+./print_summary.sh LOGFILE_LOCATION
+```
+
+This will create an output like the following:
+
+```
+Downloaded submissions: 250
+Failed downloads: 103
+Files already downloaded: 20073
+Hard linked submissions: 30
+Excluded submissions: 1146
+Files with existing hash skipped: 0
+Submissions from excluded subreddits: 0
+```

scripts/print_summary.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+if [ -e "$1" ]; then
+    file="$1"
+else
+    echo 'CANNOT FIND LOG FILE'
+    exit 1
+fi
+
+echo "Downloaded submissions: $( grep -c 'Downloaded submission' "$file" )"
+echo "Failed downloads: $( grep -c 'failed to download submission' "$file" )"
+echo "Files already downloaded: $( grep -c 'already exists, continuing' "$file" )"
+echo "Hard linked submissions: $( grep -c 'Hard link made' "$file" )"
+echo "Excluded submissions: $( grep -c 'in exclusion list' "$file" )"
+echo "Files with existing hash skipped: $( grep -c 'downloaded elsewhere' "$file" )"
+echo "Submissions from excluded subreddits: $( grep -c 'in skip list' "$file" )"