├── .gitignore ├── .clang-format ├── CMakeLists.txt ├── .github └── workflows │ └── cmake.yml ├── README.md ├── main.cpp └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | cmake-build-debug/ 2 | .idea/ 3 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: WebKit 2 | AccessModifierOffset: '-4' 3 | AllowShortFunctionsOnASingleLine: Inline 4 | AlwaysBreakTemplateDeclarations: 'true' 5 | BreakBeforeBraces: Allman 6 | ColumnLimit: '0' 7 | Cpp11BracedListStyle: 'true' 8 | PointerAlignment: Right 9 | BreakConstructorInitializers: 'AfterColon' 10 | UseTab: 'Never' 11 | AlignAfterOpenBracket: 'AlwaysBreak' 12 | AllowShortBlocksOnASingleLine: 'true' 13 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.17) 2 | project(hn_lob_comp) 3 | 4 | set(CMAKE_CXX_STANDARD 20) 5 | 6 | find_package(Threads REQUIRED) 7 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread" ) 8 | 9 | find_package(OpenSSL REQUIRED) 10 | if(OPENSSL_FOUND) 11 | set(HTTPLIB_IS_USING_OPENSSL TRUE) 12 | endif() 13 | 14 | add_executable(${PROJECT_NAME} main.cpp) 15 | 16 | target_link_libraries(${PROJECT_NAME} PUBLIC 17 | $<$:OpenSSL::SSL> 18 | $<$:OpenSSL::Crypto>) 19 | 20 | target_compile_definitions(${PROJECT_NAME} PUBLIC 21 | $<$:CPPHTTPLIB_OPENSSL_SUPPORT> 22 | ) 23 | -------------------------------------------------------------------------------- /.github/workflows/cmake.yml: -------------------------------------------------------------------------------- 1 | name: CMake 2 | 3 | on: [push] 4 | 5 | env: 6 | # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) 7 | BUILD_TYPE: Release 8 | 9 | jobs: 10 | build: 11 | # The CMake configure and build commands are platform agnostic and should work equally 12 | # well on Windows or Mac. You can convert this to a matrix build if you need 13 | # cross-platform coverage. 14 | # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | 20 | - name: Create Build Environment 21 | # Some projects don't allow in-source building, so create a separate build directory 22 | # We'll use this as our working directory for all subsequent commands 23 | run: cmake -E make_directory ${{runner.workspace}}/build 24 | 25 | - name: Configure CMake 26 | # Use a bash shell so we can use the same syntax for environment variable 27 | # access regardless of the host operating system 28 | shell: bash 29 | working-directory: ${{runner.workspace}}/build 30 | # Note the current convention is to use the -S and -B options here to specify source 31 | # and build directories, but this is only available with CMake 3.13 and higher. 32 | # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 33 | run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_C_COMPILER="clang" -DCMAKE_CXX_COMPILER="clang++" -DCMAKE_CXX_FLAGS="-Wall" 34 | 35 | 36 | - name: Build 37 | working-directory: ${{runner.workspace}}/build 38 | shell: bash 39 | # Execute the build. You can specify a specific target with "--target " 40 | run: cmake --build . --config $BUILD_TYPE 41 | 42 | - name: Run TOP 43 | working-directory: ${{runner.workspace}}/build 44 | shell: bash 45 | run: ./hn_lob_comp top 46 | 47 | - name: Run NEW 48 | working-directory: ${{runner.workspace}}/build 49 | shell: bash 50 | run: ./hn_lob_comp new 51 | 52 | - name: Run TEST 53 | working-directory: ${{runner.workspace}}/build 54 | shell: bash 55 | run: ./hn_lob_comp test 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Which stories appear both on Lobsters and on HN, who was first? 2 | 3 | **[See here for more information](https://raymii.org/s/software/Cpp_exercise_in_parsing_json_http_apis_and_time_stuff.html).** 4 | 5 | ## Installation and usage 6 | 7 | Usual cmake steps, dependency on OpenSSL (`apt install libssl-dev`) 8 | 9 | Clone the repository: 10 | 11 | git clone https://github.com/RaymiiOrg/lobsters-hn-post-compare 12 | cd lobsters-hn-post-compare 13 | 14 | Setup a cmake folder: 15 | 16 | mkdir build 17 | cd build 18 | cmake .. 19 | 20 | Compile: 21 | 22 | make 23 | 24 | Binary `hn_lob_comp` should be in the same folder. 25 | 26 | ### Usage 27 | 28 | chmod +x ./hn_lob_comp 29 | ./hn_lob_comp help 30 | 31 | 32 | Output: 33 | 34 | Which stories appear both on Lobsters and on HN, who was first? 35 | An excuse to play with parsing a JSON api in C++ with async by Remy van Elst (https://raymii.org) 36 | 37 | Current date/time: 2020-12-30T22:21:43 +0100 38 | 39 | Usage: ./hn_lob_comp [help|test|top|new] 40 | ./hn_lob_comp top: analyze top stories from HN & Lobsters. 41 | ./hn_lob_comp help: this text. 42 | ./hn_lob_comp test: run a test to check your timezones. 43 | ./hn_lob_comp new: get new posts instead of best. 44 | 45 | You'll probably want the `top` command: 46 | 47 | ./hn_lob_comp top 48 | 49 | ## Output 50 | 51 | Here's what a `top` run looks like: 52 | 53 | 54 | ``` 55 | 56 | Which stories appear both on Lobsters and on HN, who was first? 57 | An excuse to play with parsing a JSON api in C++ with async by Remy van Elst (https://raymii.org) 58 | 59 | Current date/time: 2020-12-30T22:24:57 +0100 60 | 61 | Fetching HackerNews Best Stories async (200 posts) (https://github.com/HackerNews/API) 62 | Fetching the first ten Lobsters pages async 10*25=200 posts) (https://lobste.rs/s/r9oskz/is_there_api_documentation_for_lobsters_somewhere) 63 | 64 | Number of posts from Lobsters : 200 65 | Number of posts from Hacker News : 192 66 | 67 | Matches (13): 68 | 69 | # ACE: Apple Type-C Port Controller Secrets 70 | URL: https://blog.t8012.dev/ace-part-1/ 71 | First appeared on **HackerNews** with 257 votes and 106 comments, submitted by aunali1 (2020-12-30T07:49:16 +0100; https://news.ycombinator.com/item?id=25579286 ). 72 | After 6 hours, 19 minutes, 28 seconds it was submitted to **Lobsters** by calvin with 9 votes and 1 comments (2020-12-30T14:08:44 +0100; https://lobste.rs/s/so3rb4/ace_apple_type_c_port_controller_secrets ). 73 | The highest score was reached on HackerNews and the most comments were on HackerNews. 74 | 75 | # Computer Science textbooks that are freely available online 76 | URL: https://csgordon.github.io/books.html 77 | First appeared on **HackerNews** with 534 votes and 50 comments, submitted by MrXOR (2020-12-29T19:14:07 +0100; https://news.ycombinator.com/item?id=25572852 ). 78 | After 15 hours, 48 minutes, 53 seconds it was submitted to **Lobsters** by redecas with 10 votes and 0 comments (2020-12-30T11:03:00 +0100; https://lobste.rs/s/blu8jq/colin_s_gordon_reading_list ). 79 | The highest score was reached on HackerNews and the most comments were on HackerNews. 80 | 81 | # Against Essential and Accidental Complexity 82 | URL: https://danluu.com/essential-complexity/ 83 | First appeared on **HackerNews** with 239 votes and 91 comments, submitted by weinzierl (2020-12-29T13:37:22 +0100; https://news.ycombinator.com/item?id=25569148 ). 84 | After 1 hours, 18 minutes, 24 seconds it was submitted to **Lobsters** by j11g with 40 votes and 8 comments (2020-12-29T14:55:46 +0100; https://lobste.rs/s/gvahe2/against_essential_accidental ). 85 | The highest score was reached on HackerNews and the most comments were on HackerNews. 86 | 87 | # C Template Library 88 | URL: https://github.com/glouw/ctl 89 | First appeared on **Lobsters** with 39 votes and 11 comments, submitted by glouwbug (2020-12-30T00:25:37 +0100; https://lobste.rs/s/9gc2ku/c_template_library ). 90 | **Within the hour this was also posted to HackerNews!** 91 | After 14 minutes, 54 seconds it was submitted to **HackerNews** by glouwbug with 243 votes and 115 comments (2020-12-30T00:40:31 +0100; https://news.ycombinator.com/item?id=25576466 ). 92 | The highest score was reached on HackerNews and the most comments were on HackerNews. 93 | **The same username submitted the post to both sites**. 94 | 95 | # Niex: Jupyter Notebooks but Using Elixir 96 | URL: https://github.com/jonklein/niex 97 | First appeared on **HackerNews** with 128 votes and 21 comments, submitted by niels_bom (2020-12-28T23:20:20 +0100; https://news.ycombinator.com/item?id=25563935 ). 98 | **Within the hour this was also posted to Lobsters!** 99 | After 2 minutes, 30 seconds it was submitted to **Lobsters** by friendlysock with 10 votes and 0 comments (2020-12-28T23:22:50 +0100; https://lobste.rs/s/dnw8g7/jonklein_niex_interactive_elixir_code ). 100 | The highest score was reached on HackerNews and the most comments were on HackerNews. 101 | 102 | # Cosmopolitan Libc: build-once run-anywhere C library 103 | URL: https://justine.lol/cosmopolitan/index.html 104 | First appeared on **HackerNews** with 589 votes and 163 comments, submitted by pantalaimon (2020-12-28T03:59:32 +0100; https://news.ycombinator.com/item?id=25556286 ). 105 | After 6 hours, 3 minutes, 10 seconds it was submitted to **Lobsters** by GrayGnome with 112 votes and 15 comments (2020-12-28T10:02:42 +0100; https://lobste.rs/s/xnqpyp/cosmopolitan_c_library ). 106 | The highest score was reached on HackerNews and the most comments were on HackerNews. 107 | 108 | # Virtualize Your Network on FreeBSD with VNET 109 | URL: https://klarasystems.com/articles/virtualize-your-network-on-freebsd-with-vnet/ 110 | First appeared on **HackerNews** with 74 votes and 12 comments, submitted by vermaden (2020-12-30T11:00:09 +0100; https://news.ycombinator.com/item?id=25580286 ). 111 | **Within the hour this was also posted to Lobsters!** 112 | After 12 seconds it was submitted to **Lobsters** by vermaden with 2 votes and 0 comments (2020-12-30T11:00:21 +0100; https://lobste.rs/s/r5bhmo/virtualize_your_network_on_freebsd_with ). 113 | The highest score was reached on HackerNews and the most comments were on HackerNews. 114 | **The same username submitted the post to both sites**. 115 | 116 | # Why the iPhone Timer app displays a fake time 117 | URL: https://lukashermann.dev/writing/why-the-iphone-timer-displays-fake-time/ 118 | First appeared on **HackerNews** with 220 votes and 74 comments, submitted by _antix (2020-12-28T22:56:41 +0100; https://news.ycombinator.com/item?id=25563708 ). 119 | After 13 hours, 28 minutes, 51 seconds it was submitted to **Lobsters** by Tenzer with 51 votes and 19 comments (2020-12-29T12:25:32 +0100; https://lobste.rs/s/yvw2xg/why_iphone_timer_app_displays_fake_time ). 120 | The highest score was reached on HackerNews and the most comments were on HackerNews. 121 | 122 | # Contributing Without Code 123 | URL: https://popey.com/blog/2020/12/contributing-without-code/ 124 | First appeared on **HackerNews** with 109 votes and 22 comments, submitted by pabs3 (2020-12-30T03:36:42 +0100; https://news.ycombinator.com/item?id=25577746 ). 125 | After 9 hours, 48 minutes, 21 seconds it was submitted to **Lobsters** by learnbyexample with 1 votes and 0 comments (2020-12-30T13:25:03 +0100; https://lobste.rs/s/ms9h3i/contributing_without_code ). 126 | The highest score was reached on HackerNews and the most comments were on HackerNews. 127 | 128 | # Getting Started in BBC Basic 129 | URL: https://www.bbcmicrobot.com/learn/index.html 130 | First appeared on **HackerNews** with 68 votes and 25 comments, submitted by ingve (2020-12-29T13:36:33 +0100; https://news.ycombinator.com/item?id=25569146 ). 131 | After 1 days, 6 hours, 50 minutes, 23 seconds it was submitted to **Lobsters** by gerikson with 3 votes and 0 comments (2020-12-30T20:26:56 +0100; https://lobste.rs/s/fo82h4/getting_started_bbc_basic ). 132 | The highest score was reached on HackerNews and the most comments were on HackerNews. 133 | 134 | # Implementing join planning in our open source Golang SQL query engine 135 | URL: https://www.dolthub.com/blog/2020-12-28-join-planning/ 136 | First appeared on **HackerNews** with 100 votes and 15 comments, submitted by zachmu (2020-12-28T18:39:24 +0100; https://news.ycombinator.com/item?id=25561173 ). 137 | After 21 hours, 21 minutes, 7 seconds it was submitted to **Lobsters** by eatonphil with 3 votes and 0 comments (2020-12-29T16:00:31 +0100; https://lobste.rs/s/a6suos/planning_joins_make_use_indexes ). 138 | The highest score was reached on HackerNews and the most comments were on HackerNews. 139 | 140 | # Teaching the Unfortunate Parts 141 | URL: https://www.executeprogram.com/blog/teaching-the-unfortunate-parts 142 | First appeared on **HackerNews** with 123 votes and 90 comments, submitted by gary_bernhardt (2020-12-29T00:37:26 +0100; https://news.ycombinator.com/item?id=25564666 ). 143 | After 7 hours, 22 minutes, 49 seconds it was submitted to **Lobsters** by Hail_Spacecake with 9 votes and 6 comments (2020-12-29T08:00:15 +0100; https://lobste.rs/s/4ptsq9/teaching_unfortunate_parts ). 144 | The highest score was reached on HackerNews and the most comments were on HackerNews. 145 | 146 | # Running BSDs on AMD Ryzen 5000 Series – FreeBSD/Linux Benchmarks 147 | URL: https://www.phoronix.com/scan.php?page=article&item=amd-5900x-bsd 148 | First appeared on **Lobsters** with 3 votes and 0 comments, submitted by vermaden (2020-12-30T11:02:18 +0100; https://lobste.rs/s/fmooqn/running_bsds_on_amd_ryzen_5000_series ). 149 | **Within the hour this was also posted to HackerNews!** 150 | After 5 seconds it was submitted to **HackerNews** by vermaden with 77 votes and 42 comments (2020-12-30T11:02:23 +0100; https://news.ycombinator.com/item?id=25580298 ). 151 | The highest score was reached on HackerNews and the most comments were on HackerNews. 152 | **The same username submitted the post to both sites**. 153 | 154 | # Bash HTTP Monitoring Dashboard 155 | URL: https://raymii.org/s/software/Bash_HTTP_Monitoring_Dashboard.html 156 | First appeared on **Lobsters** with 30 votes and 2 comments, submitted by raymii (2020-12-27T13:58:40 +0100; https://lobste.rs/s/4pivy1/bash_http_monitoring_dashboard ). 157 | **Within the hour this was also posted to HackerNews!** 158 | After 5 minutes, 36 seconds it was submitted to **HackerNews** by todsacerdoti with 160 votes and 26 comments (2020-12-27T14:04:16 +0100; https://news.ycombinator.com/item?id=25550732 ). 159 | The highest score was reached on HackerNews and the most comments were on HackerNews. 160 | 161 | 3 posts appeared first on Lobsters and 11 posts appeared first on HackerNews. 162 | Average time for a cross-post: 8 hours, 39 minutes, 55 seconds . 163 | Average comments on HN: 64, Lobsters: 4. 164 | Average score on HN: 212, Lobsters: 22. 165 | 166 | ``` 167 | 168 | 169 | -------------------------------------------------------------------------------- /main.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | # Copyright 2020 - Remy van Elst - https://raymii.org/s/software/Cpp_exercise_in_parsing_json_http_apis_and_time_stuff.html 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU Afferro General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # This program is distributed in the hope that it will be useful, 8 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | # GNU General Public License for more details. 11 | # You should have received a copy of the GNU General Public License 12 | # along with this program. If not, see . 13 | */ 14 | 15 | #include "httplib.hpp" 16 | #include "json.hpp" 17 | 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | 27 | #define CA_CERT_FILE "./ca-bundle.crt" 28 | 29 | using json = nlohmann::json; 30 | 31 | //wrapper function for checking whether a task has finished and 32 | //the result can be retrieved by a std::future 33 | template 34 | bool isReady(const std::future &f) 35 | { 36 | return f.wait_for(std::chrono::seconds(0)) == std::future_status::ready; 37 | } 38 | 39 | struct Post 40 | { 41 | friend std::ostream &operator<<(std::ostream &os, const Post &post) 42 | { 43 | 44 | os << "id: " << post.id << "; title: " << post.title << "; original_url: " << post.original_url << "; submitter: " << post.submitter << "; comment_url: " << post.comment_url << "; votes: " << post.votes << "; comment_count: " << post.comment_count << "; date UTC: " << printDateTimeUTC(post) << "; date local: " << printDateTimeLocal(post) << ";"; 45 | return os; 46 | } 47 | static std::string printDateTimeLocal(const Post &post) 48 | { 49 | char _submit_date[200] {""}; 50 | tm _localTime {0}; 51 | _localTime = *localtime(&post.submit_timestamp); 52 | strftime(_submit_date, sizeof(_submit_date), "%Y-%m-%dT%H:%M:%S %z", &_localTime); 53 | return std::string(_submit_date); 54 | } 55 | static std::string printDateTimeUTC(const Post &post) 56 | { 57 | char _submit_date[200] {""}; 58 | tm _utcTime {0}; 59 | _utcTime = *gmtime(&post.submit_timestamp); 60 | strftime(_submit_date, sizeof(_submit_date), "%Y-%m-%dT%H:%M:%S %z", &_utcTime); 61 | return std::string(_submit_date); 62 | } 63 | [[nodiscard]] std::string printDateTimeUTC() const 64 | { 65 | return printDateTimeUTC(*this); 66 | } 67 | [[nodiscard]] std::string printDateTimeLocal() const 68 | { 69 | return printDateTimeLocal(*this); 70 | } 71 | std::string id; 72 | time_t submit_timestamp {0}; 73 | std::string title; 74 | std::string original_url; 75 | std::string submitter; 76 | std::string comment_url; 77 | int votes {}; 78 | int comment_count {}; 79 | bool operator<(const Post &rhs) const 80 | { 81 | // tm tm_lhs = submit_date; 82 | // tm tm_rhs = rhs.submit_date; 83 | // time_t t_lhs = mktime(&tm_lhs); 84 | // time_t t_rhs = mktime(&tm_rhs); 85 | // bool timeCmp = (t_lhs < t_rhs); 86 | return (original_url < rhs.original_url); 87 | } 88 | bool operator>(const Post &rhs) const 89 | { 90 | return rhs < *this; 91 | } 92 | bool operator<=(const Post &rhs) const 93 | { 94 | return !(rhs < *this); 95 | } 96 | bool operator>=(const Post &rhs) const 97 | { 98 | return !(*this < rhs); 99 | } 100 | bool operator==(const Post &rhs) const 101 | { 102 | return original_url == rhs.original_url; 103 | } 104 | bool operator!=(const Post &rhs) const 105 | { 106 | return !(rhs == *this); 107 | } 108 | }; 109 | 110 | class httpException : public std::runtime_error 111 | { 112 | public: 113 | explicit httpException(const std::string &msg) : 114 | std::runtime_error(msg) 115 | { 116 | } 117 | }; 118 | 119 | class aggregator 120 | { 121 | public: 122 | virtual std::vector parsePosts(nlohmann::json posts) = 0; 123 | virtual json getPosts() = 0; 124 | 125 | static json getJson(const std::string &domain, const std::string &url) 126 | { 127 | httplib::SSLClient cli(domain); 128 | cli.enable_server_certificate_verification(false); 129 | httplib::Headers headers = {}; 130 | if (auto res = cli.Get(url.c_str())) 131 | { 132 | if (res->status != 200) 133 | throw httpException("HTTP Request failed. domain='" + domain + "', url='" + url + "', status code='" + std::to_string(res->status) + "', reason='" + res->reason + "'"); 134 | 135 | auto result = json::parse(res->body); 136 | return result; 137 | } 138 | else 139 | { 140 | std::string sslError; 141 | if (auto result = cli.get_openssl_verify_result()) 142 | sslError += X509_verify_cert_error_string(result); 143 | 144 | throw httpException("HTTP Request failed. domain='" + domain + "', url='" + url + "', httplib error='" + std::to_string((int)res.error()) + "', " + sslError); 145 | } 146 | } 147 | }; 148 | 149 | class lobsters : public aggregator 150 | { 151 | public: 152 | explicit lobsters(std::string domain, std::string url) : 153 | _domain(std::move(domain)), _url(std::move(url)) {}; 154 | std::vector parsePosts(json posts) override 155 | { 156 | std::vector result; 157 | for (const auto &page : posts) 158 | { 159 | for (const auto &item : page) 160 | { 161 | if (!item.contains("url")) 162 | continue; 163 | 164 | Post p; 165 | if (item.contains("comment_count")) 166 | p.comment_count = item["comment_count"]; 167 | if (item.contains("comments_url")) 168 | p.comment_url = item["comments_url"]; 169 | if (item.contains("score")) 170 | p.votes = item["score"]; 171 | if (item.contains("title")) 172 | p.title = item["title"]; 173 | if (item.contains("url")) 174 | p.original_url = item["url"]; 175 | if (item.contains("short_id")) 176 | p.id = item["short_id"]; 177 | if (item.contains("created_at")) 178 | { 179 | // format: 2020-12-28T00:22:26.000-06:00 180 | std::string dateStr = item["created_at"]; 181 | // %z doesnt like the colon in the timezone 182 | dateStr.erase(dateStr.begin() + 26); 183 | struct tm cst 184 | { 185 | 0 186 | }; 187 | auto lobsters_convert = strptime(dateStr.c_str(), "%Y-%m-%dT%H:%M:%S.000%z", &cst); 188 | if (lobsters_convert && lobsters_convert[0]) // strptime failed to convert 189 | continue; 190 | 191 | // timegm updates the static storage, copy it first. 192 | auto lobsters_utc_offset = cst.tm_gmtoff; // gcc extension 193 | time_t lobsters_epoch_without_timezone_offset = timegm(&cst); // epoch is in utc, so use timegm instead of mktime 194 | time_t lobsters_epoch = difftime(lobsters_epoch_without_timezone_offset, lobsters_utc_offset); 195 | p.submit_timestamp = lobsters_epoch; 196 | } 197 | 198 | if (item.contains("submitter_user")) 199 | for (auto &[key, value] : item["submitter_user"].items()) 200 | if (key == "username") 201 | p.submitter = value; 202 | 203 | result.push_back(p); 204 | } 205 | } 206 | return result; 207 | } 208 | 209 | json getPosts() override 210 | { 211 | json posts {}; 212 | std::vector> futures; 213 | int maxPages = 9; 214 | // Queue up all the items, 215 | for (int i = 1; i < maxPages; ++i) 216 | { 217 | std::string postUrl = std::regex_replace(_url, std::regex("%PAGENUMBER%"), std::to_string(i)); 218 | futures.push_back(std::async(std::launch::async, getJson, _domain, postUrl)); 219 | } 220 | 221 | // Wait until all futures are finished 222 | int finishedFutures = 1; 223 | while (finishedFutures < maxPages) 224 | { 225 | for (const auto &future : futures) 226 | { 227 | if (isReady(future)) 228 | ++finishedFutures; 229 | } 230 | } 231 | 232 | for (auto &future : futures) 233 | { 234 | posts.push_back(future.get()); 235 | } 236 | 237 | return posts; 238 | } 239 | 240 | private: 241 | std::string _url; 242 | std::string _domain; 243 | }; 244 | 245 | class hackernews : public aggregator 246 | { 247 | public: 248 | explicit hackernews(std::string domain, std::string id_url, std::string story_url) : 249 | _domain(std::move(domain)), _id_url(std::move(id_url)), _story_url(std::move(story_url)) {}; 250 | 251 | std::vector parsePosts(json posts) override 252 | { 253 | std::vector result; 254 | for (const auto &item : posts) 255 | { 256 | bool isStory = (item.contains("type") && item["type"].get() == "story"); 257 | if (!isStory) 258 | continue; 259 | if (!item.contains("url")) 260 | continue; 261 | 262 | Post p; 263 | if (item.contains("descendants")) 264 | p.comment_count = item["descendants"]; 265 | if (item.contains("score")) 266 | p.votes = item["score"]; 267 | if (item.contains("title")) 268 | p.title = item["title"]; 269 | if (item.contains("url")) 270 | p.original_url = item["url"]; 271 | if (item.contains("by")) 272 | p.submitter = item["by"]; 273 | if (item.contains("id")) 274 | { 275 | p.id = std::to_string(item["id"].get()); 276 | p.comment_url = "https://news.ycombinator.com/item?id=" + p.id; 277 | } 278 | if (item.contains("time")) 279 | { 280 | // format: 1609012592 (epoch) (epoch is always utc) 281 | std::string dateStr = std::to_string(item["time"].get()); 282 | time_t hn_epoch = std::stoll(dateStr); 283 | p.submit_timestamp = hn_epoch; 284 | } 285 | 286 | result.push_back(p); 287 | } 288 | 289 | return result; 290 | } 291 | 292 | json getPosts() override 293 | { 294 | json posts {}; 295 | std::vector> futures; 296 | int counter = 1; 297 | int maxPosts = 200; 298 | 299 | // Queue up all the items, 300 | for (const auto &id : getJson(_domain, _id_url)) 301 | { 302 | std::string postId = std::to_string(id.get()); 303 | std::string postUrl = std::regex_replace(_story_url, std::regex("%ID%"), postId); 304 | futures.push_back(std::async(std::launch::async, getJson, _domain, postUrl)); 305 | if (counter > maxPosts) 306 | break; 307 | ++counter; 308 | } 309 | 310 | // Wait until all futures are finished 311 | int finishedFutures = 0; 312 | while (finishedFutures < maxPosts) 313 | { 314 | for (const auto &future : futures) 315 | { 316 | if (isReady(future)) 317 | ++finishedFutures; 318 | } 319 | } 320 | 321 | for (auto &future : futures) 322 | { 323 | posts.push_back(future.get()); 324 | } 325 | 326 | return posts; 327 | } 328 | 329 | private: 330 | std::string _id_url; 331 | std::string _story_url; 332 | std::string _domain; 333 | }; 334 | 335 | void printTm(const tm *tp); 336 | void printCurrentDate() 337 | { 338 | time_t t_now = time(nullptr); 339 | tm *tm_now = localtime(&t_now); 340 | char now[200] {""}; 341 | strftime(now, sizeof(now), "%Y-%m-%dT%H:%M:%S %z", tm_now); 342 | std::cout << "Current date/time: " << now << "\n\n"; 343 | } 344 | 345 | void printTm(const tm *tp) 346 | { 347 | if (tp->tm_yday > 0) 348 | std::cout << tp->tm_yday << " days, "; 349 | if (tp->tm_hour > 0) 350 | std::cout << tp->tm_hour << " hours, "; 351 | if (tp->tm_min > 0) 352 | std::cout << tp->tm_min << " minutes, "; 353 | if (tp->tm_sec > 0) 354 | std::cout << tp->tm_sec << " seconds "; 355 | } 356 | 357 | template 358 | T calcAverage(const std::vector &vec) 359 | { 360 | auto sum = std::accumulate(vec.cbegin(), vec.cend(), 0); 361 | return sum / vec.size(); 362 | } 363 | 364 | void analyze(std::vector &lobstersPosts, std::vector &hnPosts) 365 | { 366 | std::cout << "Number of posts from Lobsters : " << lobstersPosts.size() << "\n"; 367 | std::cout << "Number of posts from Hacker News : " << hnPosts.size() << "\n\n"; 368 | 369 | // set_intersection requires vectors to be sorted 370 | std::sort(hnPosts.begin(), hnPosts.end()); 371 | std::sort(lobstersPosts.begin(), lobstersPosts.end()); 372 | 373 | std::vector post_intersection; 374 | std::set_intersection(hnPosts.begin(), hnPosts.end(), lobstersPosts.begin(), lobstersPosts.end(), std::back_inserter(post_intersection)); 375 | 376 | std::cout << "Matches (" << post_intersection.size() << "):\n\n"; 377 | 378 | std::vector firstOnLobsters; 379 | std::vector lastOnLobsters; 380 | std::vector firstOnHN; 381 | std::vector lastOnHN; 382 | std::vector timeDiff; 383 | std::vector lobstersScore; 384 | std::vector lobstersComments; 385 | 386 | std::vector hnScore; 387 | std::vector hnComments; 388 | 389 | for (const auto &p : post_intersection) 390 | { 391 | auto hnPost = std::find_if(hnPosts.begin(), hnPosts.end(), [&cp = p](const Post &p) -> bool { return cp == p; }); 392 | if (hnPost == hnPosts.end()) 393 | continue; 394 | 395 | auto lobstersPost = std::find_if(lobstersPosts.begin(), lobstersPosts.end(), [&cp = p](const Post &p) -> bool { return cp == p; }); 396 | if (lobstersPost == lobstersPosts.end()) 397 | continue; 398 | 399 | Post firstPost = *lobstersPost; 400 | Post secondPost = *hnPost; 401 | std::string firstName = "Lobsters"; 402 | std::string secondName = "HackerNews"; 403 | if (hnPost->submit_timestamp < lobstersPost->submit_timestamp) 404 | { 405 | firstOnHN.push_back(p); 406 | lastOnLobsters.push_back(p); 407 | std::swap(firstName, secondName); 408 | std::swap(firstPost, secondPost); 409 | } 410 | else 411 | { 412 | firstOnLobsters.push_back(p); 413 | lastOnHN.push_back(p); 414 | } 415 | 416 | lobstersComments.push_back(lobstersPost->comment_count); 417 | lobstersScore.push_back(lobstersPost->votes); 418 | hnComments.push_back(hnPost->comment_count); 419 | hnScore.push_back(hnPost->votes); 420 | 421 | std::cout << "# " << p.title << " \nURL: " << p.original_url << " \n"; 422 | 423 | std::cout << "First appeared on **" << firstName << "** with " << firstPost.votes 424 | << " votes and " << firstPost.comment_count << " comments, submitted by " 425 | << firstPost.submitter << " (" << firstPost.printDateTimeLocal() << "; " 426 | << firstPost.comment_url << " ). \n"; 427 | 428 | time_t diffSec = difftime(secondPost.submit_timestamp, firstPost.submit_timestamp); 429 | 430 | timeDiff.push_back(diffSec); 431 | 432 | if (std::chrono::seconds(diffSec) < std::chrono::hours(1)) 433 | std::cout << "**Within the hour this was also posted to " << secondName << "!**\n"; 434 | 435 | tm *tp = gmtime(&diffSec); // utc 436 | std::cout << "After "; 437 | printTm(tp); 438 | 439 | std::cout << "it was submitted to **" << secondName << "** by " << secondPost.submitter << " with " 440 | << secondPost.votes << " votes and " << secondPost.comment_count << " comments (" 441 | << secondPost.printDateTimeLocal() << "; " << secondPost.comment_url << " ). \n"; 442 | 443 | std::string highestScore = (firstPost.votes > secondPost.votes) ? firstName : secondName; 444 | if ((firstPost.votes + secondPost.votes) <= 0) 445 | highestScore = "nowhere"; 446 | 447 | std::string mostComments = (firstPost.comment_count > secondPost.comment_count) ? firstName : secondName; 448 | if ((firstPost.comment_count + secondPost.comment_count) <= 0) 449 | mostComments = "nowhere"; 450 | 451 | std::cout << "The highest score was reached on " << highestScore 452 | << " and the most comments were on " << mostComments << ". \n"; 453 | 454 | if (firstPost.submitter == secondPost.submitter) 455 | std::cout << "**The same username submitted the post to both sites**. \n"; 456 | 457 | std::cout << "\n"; 458 | } 459 | 460 | std::cout << firstOnLobsters.size() << " posts appeared first on Lobsters and " << firstOnHN.size() << " posts appeared first on HackerNews.\n"; 461 | 462 | time_t sum = std::accumulate(timeDiff.cbegin(), timeDiff.cend(), 0ll); 463 | time_t avg = sum / timeDiff.size(); 464 | 465 | tm *diff_tp = gmtime(&avg); 466 | std::cout << "Average time for a cross-post: "; 467 | printTm(diff_tp); 468 | std::cout << ".\n"; 469 | 470 | std::cout << "Average comments on HN: " << calcAverage(hnComments) << ", Lobsters: " << calcAverage(lobstersComments) << ".\n"; 471 | std::cout << "Average score on HN: " << calcAverage(hnScore) << ", Lobsters: " << calcAverage(lobstersScore) << ".\n"; 472 | } 473 | 474 | std::vector &Arguments() 475 | { 476 | static std::vector arguments; 477 | return arguments; 478 | } 479 | 480 | void usage() 481 | { 482 | std::cout << "Usage: " << Arguments().at(0) << " [help|test|top|new]\n"; 483 | std::cout << Arguments().at(0) << " top: analyze top stories from HN & Lobsters.\n"; 484 | std::cout << Arguments().at(0) << " help: this text.\n"; 485 | std::cout << Arguments().at(0) << " test: run a test to check your timezones.\n"; 486 | std::cout << Arguments().at(0) << " new: get new posts instead of best.\n"; 487 | } 488 | 489 | int main(int argc, char *argv[]) 490 | { 491 | for (int i = 0; i < argc; ++i) 492 | { 493 | Arguments().push_back(argv[i]); 494 | } 495 | 496 | #ifndef __GNUG__ 497 | std::cout << "Please use GCC to compile, we're using it's struct tm tm_gmtoff extension."; 498 | return 1; 499 | #endif 500 | 501 | std::cout << "Which stories appear both on Lobsters and on HN, who was first?\n"; 502 | std::cout << "An excuse to play with parsing a JSON api in C++ with async by Remy van Elst (https://raymii.org)\n\n"; 503 | 504 | printCurrentDate(); 505 | 506 | auto lobster = lobsters("lobste.rs", "/page/%PAGENUMBER%.json"); 507 | auto hn = hackernews("hacker-news.firebaseio.com", "/v0/beststories.json", "/v0/item/%ID%.json"); 508 | 509 | if (Arguments().size() >= 2 && Arguments().at(1) == "help") 510 | { 511 | usage(); 512 | return 0; 513 | } 514 | 515 | if (Arguments().size() >= 2 && Arguments().at(1) == "new") 516 | { 517 | lobster = lobsters("lobste.rs", "/newest/page/%PAGENUMBER%.json"); 518 | hn = hackernews("hacker-news.firebaseio.com", "/v0/newstories.json", "/v0/item/%ID%.json"); 519 | 520 | std::cout << "Fetching HackerNews New Stories async (200 posts) (https://github.com/HackerNews/API)\n"; 521 | std::vector hnPosts = hn.parsePosts(hn.getPosts()); 522 | 523 | std::cout << "Fetching the first ten Lobsters pages (/newest) async 10*25=200 posts) (https://lobste.rs/s/r9oskz/is_there_api_documentation_for_lobsters_somewhere)\n\n"; 524 | std::vector lobstersPosts = lobster.parsePosts(lobster.getPosts()); 525 | 526 | analyze(lobstersPosts, hnPosts); 527 | return 0; 528 | } 529 | 530 | if (Arguments().size() >= 2 && Arguments().at(1) == "test") 531 | { 532 | /* hn time 1609074256 converts to GMT: Sunday December 27, 2020 13:04:16 533 | lobsters time 2020-12-27T06:58-06:00 converts to GMT: Sunday December 27, 2020 12:58:40 534 | difference should be 5 minutes, 36 seconds. 535 | */ 536 | std::cout << "--- START TEST ---\nDate/time/timezones are hard. Below is a test post comparison," 537 | "check if your timezone information is correct. The difference between Lobsters and " 538 | "HN should be 5 minutes and 36 seconds. \n"; 539 | std::string lobsters_test_json = "[[{\"short_id\":\"4pivy1\",\"short_id_url\":\"https://lobste.rs/s/4pivy1\",\"created_at\":\"2020-12-27T06:58:40.000-06:00\",\"title\":\"Bash HTTP monitoring dashboard\",\"url\":\"https://raymii.org/s/software/Bash_HTTP_Monitoring_Dashboard.html\",\"score\":30,\"flags\":0,\"comment_count\":2,\"description\":\"\",\"comments_url\":\"https://lobste.rs/s/4pivy1/bash_http_monitoring_dashboard\",\"submitter_user\":{\"username\":\"raymii\",\"created_at\":\"2013-11-20T11:58:43.000-06:00\",\"is_admin\":false,\"about\":\"https://raymii.org\",\"is_moderator\":false,\"karma\":7351,\"avatar_url\":\"/avatars/raymii-100.png\",\"invited_by_user\":\"journeysquid\"},\"tags\":[\"linux\",\"web\"],\"comments\":[{\"short_id\":\"zdonpb\",\"short_id_url\":\"https://lobste.rs/c/zdonpb\",\"created_at\":\"2020-12-28T06:50:10.000-06:00\",\"updated_at\":\"2020-12-28T06:51:33.000-06:00\",\"is_deleted\":false,\"is_moderated\":false,\"score\":2,\"flags\":0,\"comment\":\"\\u003cp\\u003eThanks Remy, I enjoyed reading through the shell script source, which inspired me to write a \\u003ca href=\\\"https://lobste.rs/s/2ougg7/waiting_for_jobs_concept_shell\\\" rel=\\\"ugc\\\"\\u003epost about \\u003ccode\\u003ewait\\u003c/code\\u003e, and about shell scripting\\u003c/a\\u003e today.\\u003c/p\\u003e\\n\",\"url\":\"https://lobste.rs/s/4pivy1/bash_http_monitoring_dashboard#c_zdonpb\",\"indent_level\":1,\"commenting_user\":{\"username\":\"qmacro\",\"created_at\":\"2020-01-24T10:48:42.000-06:00\",\"is_admin\":false,\"about\":\"[Developer, author, teacher, speaker](https://qmacro.org). And fascinated by all sorts of stuff.\",\"is_moderator\":false,\"karma\":79,\"avatar_url\":\"/avatars/qmacro-100.png\",\"invited_by_user\":\"martinrue\",\"github_username\":\"qmacro\",\"twitter_username\":\"qmacro\"}},{\"short_id\":\"lalafr\",\"short_id_url\":\"https://lobste.rs/c/lalafr\",\"created_at\":\"2020-12-28T08:38:37.000-06:00\",\"updated_at\":\"2020-12-28T08:38:37.000-06:00\",\"is_deleted\":false,\"is_moderated\":false,\"score\":3,\"flags\":0,\"comment\":\"\\u003cp\\u003eThat is a great post, fun to read. I like such posts with backstory and musings. Often unable to write those myself, I’d rather stick to guides.\\u003c/p\\u003e\\n\\u003cp\\u003eSubscribed to your rss feed as well.\",\"url\":\"https://lobste.rs/s/4pivy1/bash_http_monitoring_dashboard#c_lalafr\",\"indent_level\":2,\"commenting_user\":{\"username\":\"raymii\",\"created_at\":\"2013-11-20T11:58:43.000-06:00\",\"is_admin\":false,\"about\":\"https://raymii.org\",\"is_moderator\":false,\"karma\":7351,\"avatar_url\":\"/avatars/raymii-100.png\",\"invited_by_user\":\"journeysquid\"}}]}]]"; 540 | std::string hn_test_json = "[{\"by\":\"todsacerdoti\",\"descendants\":26,\"id\":25550732,\"kids\":[25551346,25551828,25552963,25556255,25552339,25559309,25554106,25553520,25552809,25557037],\"score\":154,\"time\":1609074256,\"title\":\"Bash HTTP Monitoring Dashboard\",\"type\":\"story\",\"url\":\"https://raymii.org/s/software/Bash_HTTP_Monitoring_Dashboard.html\"}]"; 541 | 542 | std::vector test_hnPosts = hn.parsePosts(json::parse(hn_test_json)); 543 | std::vector test_lobstersPosts = lobster.parsePosts(json::parse(lobsters_test_json)); 544 | analyze(test_lobstersPosts, test_hnPosts); 545 | 546 | std::cout << "--- END TEST ---\n\n"; 547 | return 0; 548 | } 549 | 550 | if (Arguments().size() >= 2 && Arguments().at(1) == "top") 551 | { 552 | std::cout << "Fetching HackerNews Best Stories async (200 posts) (https://github.com/HackerNews/API)\n"; 553 | std::vector hnPosts = hn.parsePosts(hn.getPosts()); 554 | 555 | std::cout << "Fetching the first ten Lobsters pages async 10*25=200 posts) (https://lobste.rs/s/r9oskz/is_there_api_documentation_for_lobsters_somewhere)\n\n"; 556 | std::vector lobstersPosts = lobster.parsePosts(lobster.getPosts()); 557 | 558 | analyze(lobstersPosts, hnPosts); 559 | return 0; 560 | } 561 | 562 | usage(); 563 | return 0; 564 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------