├── .codespellignore ├── .github └── workflows │ ├── linting.yml │ └── tests.yml ├── .gitignore ├── .pre-commit-config.yaml ├── .vscode └── settings.json ├── LICENSE ├── README.md ├── bolthandler.go ├── bolthandler_test.go ├── csvhandler.go ├── datacopier.go ├── distil.sh ├── example.csv ├── go.mod ├── go.sum ├── httpresponse_test.go ├── jsonhandler.go ├── justfile ├── linkstat.go ├── linkstathandler.go ├── listprocessor.go └── version.go /.codespellignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/httpreserve/linkstat/cafcb5646a664b786153c683c50cb680f2747550/.codespellignore -------------------------------------------------------------------------------- /.github/workflows/linting.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: linting 3 | 4 | on: 5 | pull_request: 6 | push: 7 | branches: [main] 8 | 9 | jobs: 10 | ci: 11 | name: "run linting" 12 | strategy: 13 | fail-fast: true 14 | matrix: 15 | os: ["ubuntu-latest"] 16 | go: ["1.23.x"] 17 | runs-on: ${{ matrix.os }} 18 | steps: 19 | - name: "checkout" 20 | uses: actions/checkout@v4 21 | - name: "fetch unshallow" 22 | run: git fetch --prune --unshallow 23 | - name: Set up Go 24 | uses: actions/setup-go@v5 25 | with: 26 | go-version: ${{ matrix.go }} 27 | - name: "fmt" 28 | run: if [ "$(go fmt ./... | wc -l)" -gt 0 ]; then echo "go fmt failed, please run again locally"; exit 1; fi 29 | - name: "vet" 30 | run: "go vet ./..." 31 | - name: "setup imports" 32 | run: "go install golang.org/x/tools/cmd/goimports@latest" 33 | - name: "test imports" 34 | run: if [ "$(goimports -l . | wc -l)" -gt 0 ]; then echo "goimports failed, please run again locally"; exit 1; fi 35 | - name: "setup staticcheck" 36 | run: "go install honnef.co/go/tools/cmd/staticcheck@latest" 37 | - name: staticcheck 38 | run: "staticcheck ./..." 39 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: unit-tests 3 | 4 | on: 5 | pull_request: 6 | push: 7 | branches: [main] 8 | 9 | jobs: 10 | ci: 11 | name: "run linting" 12 | strategy: 13 | fail-fast: true 14 | matrix: 15 | os: ["ubuntu-latest", "windows-latest", "macOS-latest"] 16 | go: ["1.22.x", "1.23.x"] 17 | runs-on: ${{ matrix.os }} 18 | steps: 19 | - name: "checkout" 20 | uses: actions/checkout@v4 21 | - name: "fetch unshallow" 22 | run: git fetch --prune --unshallow 23 | - name: Set up Go 24 | uses: actions/setup-go@v5 25 | with: 26 | go-version: ${{ matrix.go }} 27 | - name: "test" 28 | run: "go test ./..." 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | linkstat.exe 2 | release/* 3 | linkstat 4 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v5.0.0 4 | hooks: 5 | - id: check-yaml 6 | - id: check-json 7 | - id: check-toml 8 | - id: end-of-file-fixer 9 | - id: trailing-whitespace 10 | - id: check-case-conflict 11 | - repo: https://github.com/igorshubovych/markdownlint-cli 12 | rev: v0.42.0 13 | hooks: 14 | - id: markdownlint 15 | - repo: https://github.com/codespell-project/codespell 16 | rev: v2.3.0 17 | hooks: 18 | - id: codespell 19 | args: [-I, .codespellignore] 20 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "editor.insertSpaces": true, 3 | "editor.tabSize": 4, 4 | "editor.rulers": [ 5 | 79 6 | ], 7 | "editor.detectIndentation": false, 8 | "files.trimTrailingWhitespace": true, 9 | "files.insertFinalNewline": true, 10 | "python.linting.mypyEnabled": false, 11 | "python.linting.flake8Enabled": true, 12 | "python.linting.pylintEnabled": true, 13 | "python.linting.lintOnSave": true, 14 | "git.inputValidationSubjectLength": 50, 15 | "git.inputValidationLength": 72, 16 | "[git-commit]": { 17 | "editor.rulers": [ 18 | 50, 19 | 72 20 | ] 21 | }, 22 | "[python]": { 23 | "editor.rulers": [ 24 | 72, 25 | 79, 26 | 120 27 | ], 28 | "editor.formatOnSave": true, 29 | "editor.defaultFormatter": "ms-python.black-formatter" 30 | }, 31 | "[go]": { 32 | "editor.rulers": [ 33 | 72, 34 | 79 35 | ] 36 | }, 37 | "[markdown]": { 38 | "editor.rulers": [80] 39 | }, 40 | "[makefile]": { 41 | "editor.insertSpaces": false, 42 | "editor.tabSize": 4 43 | }, 44 | "files.eol": "\n", 45 | "cSpell.words": [ 46 | "ADAAGIX", 47 | "ADADJED", 48 | "ADAEUR", 49 | "ADAFACT", 50 | "ADAUSD", 51 | "ADAWMT", 52 | "AGIX", 53 | "ALGORAND", 54 | "apsw", 55 | "autouse", 56 | "cafile", 57 | "Cardano", 58 | "certifi", 59 | "conlist", 60 | "DJED", 61 | "dotenv", 62 | "fastapi", 63 | "freezegun", 64 | "kucoin", 65 | "lastrowid", 66 | "LENFI", 67 | "LQADA", 68 | "Orcfax", 69 | "pickleable", 70 | "pydantic", 71 | "rowid", 72 | "upgrader", 73 | "utxo", 74 | "websockets", 75 | "WMTADA", 76 | "WMTAGIX", 77 | "WMTDJED", 78 | "WMTLENFI" 79 | ] 80 | } 81 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |

3 | 4 |

5 |
6 | 7 | # linkstat 8 | 9 | CLI implementation of httpreserve that can test links and retrieve Internet 10 | Archive replacements. The tool can output the result of individual links, or 11 | take a CSV list to output collected information in JSON, BoltDB, or CSV format. 12 | 13 | ## Usage 14 | ```bash 15 | Usage: linkstat [Optional -link] [Optional -label] 16 | [Optional -list] [Optional -json] 17 | [Optional -bolt] 18 | [Optional -csv] 19 | [Optional -version -v] 20 | 21 | Output: [Json] 22 | Output: [CSV] 23 | Output: [BoltDB] 24 | Output: [Version] 'exponentialDK-httpreserve/0.0.9 ...' 25 | 26 | Usage of ./linkstat: 27 | -bolt 28 | Output to static BoltDB. 29 | -csv 30 | Output to CSV. 31 | -json 32 | Output to JSON. 33 | -label string 34 | Annotate single URL check response with label. 35 | -link string 36 | Seek the status of a single URL: JSON 37 | -list string 38 | Provide a list of URLs to test against in CSV format. 39 | -v Return httpreserve version. 40 | -version 41 | Return httpreserve version. 42 | ``` 43 | 44 | ## Examples 45 | 46 | #### Example combining [tikalinkextract][httpreserve-1] 47 | 48 | Inspired by Harvard Innovation Labs to test the ability of 49 | httpreserve-workbench at the time. This CLI version is a simplification of that 50 | work but should still produce decent results. HTTPreserve 51 | [Million Dollar Webpage Project][httpreserve-2] 52 | 53 | [httpreserve-1]: https://github.com/httpreserve/tikalinkextract 54 | [httpreserve-2]: https://github.com/httpreserve/million-dollar-webpage 55 | 56 | #### CSV input 57 | 58 | An input CSV `example.csv` might look as follows: 59 | ```csv 60 | "BBC News", "http://www.bbc.co.uk/news" 61 | "BBC Home", "http://www.bbc.co.uk/" 62 | "BBC Radio", "http://www.bbc.co.uk/radio" 63 | "Google", "http://www.google.com" 64 | "exponentialdecay.co.uk", "http://www.exponentialdecay.co.uk" 65 | "Internet Archive", "http://www.archive.org" 66 | "perma.cc", "http://perma.cc" 67 | "wikipedia.org", "http://wikipedia.org" 68 | "The Million Dollar Homepage", "http://www.getpixel.net" 69 | ``` 70 | 71 | To output a CSV collecting all of the linkstat results, you can run a command 72 | as follows: 73 | ```bash 74 | $ ./linkstat -csv --list example.csv > output.csv 75 | ``` 76 | 77 | And the output looks as follows: 78 | ``` 79 | "id","filename","link","response code","response text","title","content-type","archived","internet archive response code","internet archive response text","wayback earliest date","internet archive earliest","wayback latest date","internet archive latest","internet archive save link","protocol error","protocol error","analysis version number","analysis version text","stats creation time" 80 | "1651a00b16a12ba06fc6c6b049c7cf7c","BBC News","https://www.bbc.co.uk/news","200","OK","home - bbc news","text/html;charset=utf-8","true","302","Found","09 October 1997","http://web.archive.org/web/19971009011901/http://www.bbc.co.uk/news/","19 March 2019","http://web.archive.org/web/20190319173721/https://www.bbc.co.uk/news","http://web.archive.org/save/https://www.bbc.co.uk/news","","","0.0.9","exponentialDK-httpreserve/0.0.9","1.574649021s" 81 | "57ab6349a47b53b982a939fb1da54fef","BBC Radio","https://www.bbc.co.uk/sounds","200","OK","bbc sounds - music. radio. podcasts","text/html; charset=utf-8","true","302","Found","19 March 2008","http://web.archive.org/web/20080319074038/http://www.bbc.co.uk/sounds","18 March 2019","http://web.archive.org/web/20190318211158/https://www.bbc.co.uk/sounds","http://web.archive.org/save/https://www.bbc.co.uk/sounds","","","0.0.9","exponentialDK-httpreserve/0.0.9","1.660729358s" 82 | "c85da5e372ffe2200e46527b74537ba3","BBC Home","https://www.bbc.co.uk/","200","OK","bbc - home","text/html; charset=utf-8","true","302","Found","21 December 1996","http://web.archive.org/web/19961221203254/http://www0.bbc.co.uk/","19 March 2019","http://web.archive.org/web/20190319141018/https://www.bbc.co.uk/","http://web.archive.org/save/https://www.bbc.co.uk/","","","0.0.9","exponentialDK-httpreserve/0.0.9","1.95442772s" 83 | "b3bd672c1014e07e87ef4a357a161528","exponentialdecay.co.uk","http://www.exponentialdecay.co.uk","206","Partial Content","ross spencer, digital preservation, archives, python developer, golang developer, uk, nz","text/html","true","302","Found","17 September 2008","http://web.archive.org/web/20080917054811/http://www.exponentialdecay.co.uk/","13 November 2018","http://web.archive.org/web/20181113021338/http://exponentialdecay.co.uk/","http://web.archive.org/save/http://www.exponentialdecay.co.uk","","","0.0.9","exponentialDK-httpreserve/0.0.9","425.368183ms" 84 | ``` 85 | 86 | #### An individual link 87 | 88 | The command: `./linkstat -link https://github.com/ -label "GitHub"` will 89 | output: 90 | ```json 91 | { 92 | "FileName": "GitHub", 93 | "AnalysisVersionNumber": "0.0.15", 94 | "AnalysisVersionText": "exponentialDK-httpreserve/0.0.15", 95 | "SimpleRequestVersion": "httpreserve-simplerequest/0.0.4", 96 | "Link": "https://github.com/", 97 | "Title": "github: let’s build from here · github", 98 | "ContentType": "text/html; charset=utf-8", 99 | "ResponseCode": 200, 100 | "ResponseText": "OK", 101 | "SourceURL": "https://github.com/", 102 | "ScreenShot": "snapshots are not currently enabled", 103 | "InternetArchiveLinkEarliest": "http://web.archive.org/web/20080514210148/http://github.com/", 104 | "InternetArchiveEarliestDate": "2008-05-14 21:01:48 +0000 UTC", 105 | "InternetArchiveLinkLatest": "http://web.archive.org/web/20230829062855/https://github.com/", 106 | "InternetArchiveLatestDate": "2023-08-29 06:28:55 +0000 UTC", 107 | "InternetArchiveSaveLink": "http://web.archive.org/save/https://github.com/", 108 | "InternetArchiveResponseCode": 302, 109 | "InternetArchiveResponseText": "Found", 110 | "RobustLinkEarliest": "HTTPreserve Robust Link - simply replace this text!!", 111 | "RobustLinkLatest": "HTTPreserve Robust Link - simply replace this text!!", 112 | "PWID": "urn:pwid:archive.org:2023-08-29T06:28:55Z:page:https://github.com/", 113 | "Archived": true, 114 | "Error": false, 115 | "ErrorMessage": "", 116 | "StatsCreationTime": "7.070152149s" 117 | } 118 | ``` 119 | 120 | ## Archiving Weblinks 121 | 122 | * [Find and Connect Project:][linkstat-1] Nicola Laurent on the impact of 123 | broken links. 124 | * [Binary Trees? Automatically Identifying the links between born digital records:][linkstat-2] 125 | I write about hyperlinks as a public record in own right when submitted as part 126 | of a documentary heritage. 127 | * [HiberActive Pilot][linkstat-3] A scholarly publishing tool that extracts 128 | URLs, returns both the original URL and a perma-link. 129 | * [IIPC Awesome List][linkstat-4] A list of web-archiving links that invites 130 | contributions from the community to keep it up-to-date. 131 | 132 | [linkstat-1]: http://www.findandconnectwrblog.info/2016/11/broken-links-broken-trust/ 133 | [linkstat-2]: https://www.youtube.com/watch?v=Ked9GRmKlRw 134 | [linkstat-3]: https://www.era.lib.ed.ac.uk/handle/1842/23366 135 | [linkstat-4]: https://github.com/iipc/awesome-web-archiving 136 | 137 | ## License 138 | 139 | GNU General Public License Version 3. [Full Text](LICENSE) 140 | -------------------------------------------------------------------------------- /bolthandler.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "log" 7 | "os" 8 | "time" 9 | 10 | "github.com/httpreserve/httpreserve" 11 | kval "github.com/kval-access-language/kval-bbolt" 12 | "github.com/speps/go-hashids" 13 | ) 14 | 15 | // values to use to create hashid 16 | var salt = "httpreserve" 17 | var namelen = 8 18 | 19 | // bucket constants 20 | const linkIndex = "link index" 21 | 22 | // const fnameIndex = "filename index" 23 | const hashIndex = "hash index" 24 | 25 | // location for bolt databases. Names are random at present because 26 | // I'm unsure how they're going to be used in future so may write naming 27 | // functions and flags at a later date. 28 | const boltdir = "db/" 29 | 30 | // For stdout the name of the database 31 | var boltoutput string 32 | 33 | // getNewDBName provides three integers based on the time at 34 | // which we run the code to help us create a hashid name for the db. 35 | func getNewDBName() []int { 36 | t := time.Now() 37 | i1 := t.Minute() 38 | i2 := t.Second() 39 | i3 := t.Nanosecond() 40 | return []int{i1, i2, i3} 41 | } 42 | 43 | // configureHashID will create a hashids name for our database 44 | func configureHashID() string { 45 | 46 | name := getNewDBName() 47 | 48 | //hashdata 49 | hd := hashids.NewData() 50 | hd.Salt = salt 51 | hd.MinLength = namelen 52 | 53 | //hash 54 | h, _ := hashids.NewWithData(hd) 55 | e, _ := h.Encode(name) 56 | return e 57 | } 58 | 59 | // makeIDIndex will write rows to the BoldDB based on an MD5 hash value 60 | // associated with the lmap passed to the function (a deconstructed LinkStats) 61 | func makeIDIndex(kb kval.Kvalboltdb, lmap map[string]interface{}) { 62 | for k, v := range lmap { 63 | _, err := kval.Query(kb, "INS "+convertInterface(lmap["response code"])+">>"+convertInterface(lmap["link"])+" >>>> "+k+" :: "+convertInterface(v)) 64 | if err != nil { 65 | fmt.Fprintln(os.Stderr, err) 66 | } 67 | } 68 | } 69 | 70 | // makeBoltDir will create a database for all BoldDB files generated 71 | // if the database doesn't already exist. 72 | func makeBoltDir() { 73 | if _, err := os.Stat(boltdir); os.IsNotExist(err) { 74 | err := os.Mkdir(boltdir, 0700) 75 | if err != nil { 76 | fmt.Fprintln(os.Stderr, err) 77 | os.Exit(1) 78 | } 79 | } 80 | } 81 | 82 | // boltGetResultContainers returns the names of all top level buckets 83 | // n.b. these functions are heavily linked to the database schema and 84 | // could be made more generic with more effort. 85 | func boltGetResultContainers(kb kval.Kvalboltdb) []string { 86 | var buckets []string 87 | q := "GET " + hashIndex 88 | res, _ := kval.Query(kb, q) 89 | for k := range res.Result { 90 | buckets = append(buckets, k) 91 | } 92 | return buckets 93 | } 94 | 95 | // boltGetSingleRecord will return a single record for a given md5 key 96 | // n.b. these functions are heavily linked to the database schema and 97 | // could be made more generic with more effort. 98 | func boltGetSingleRecord(kb kval.Kvalboltdb, md5Key string) map[string]string { 99 | records := make(map[string]string) 100 | q := "GET " + hashIndex + " >> " + md5Key 101 | res, _ := kval.Query(kb, q) 102 | for k, v := range res.Result { 103 | records[k] = v 104 | } 105 | return records 106 | } 107 | 108 | // boltGetAllRecords returns all records in all top level buckets in the 109 | // database. 110 | // n.b. these functions are heavily linked to the database schema and 111 | // could be made more generic with more effort. 112 | func boltGetAllRecords(kb kval.Kvalboltdb) []map[string]string { 113 | var records []map[string]string 114 | keys := boltGetResultContainers(kb) 115 | for _, v := range keys { 116 | records = append(records, boltGetSingleRecord(kb, v)) 117 | } 118 | return records 119 | } 120 | 121 | var kb kval.Kvalboltdb 122 | 123 | func openKVALBolt() { 124 | var err error 125 | boltname := configureHashID() 126 | makeBoltDir() 127 | 128 | boltoutput = boltdir + "HP_" + boltname + ".bolt" 129 | kb, err = kval.Connect(boltoutput) 130 | if err != nil { 131 | fmt.Fprintf(os.Stderr, "Error opening bolt database: %+v\n", err) 132 | os.Exit(1) 133 | } 134 | } 135 | 136 | func closeKVALBolt() { 137 | kval.Disconnect(kb) 138 | } 139 | 140 | var id []string 141 | 142 | // boltdbHandler is the primary handler for writing to a BoltDB 143 | // from our httpreserve results rsets. 144 | func boltdbHandler(js string) { 145 | 146 | var ls httpreserve.LinkStats 147 | 148 | err := json.Unmarshal([]byte(js), &ls) 149 | if err != nil { 150 | fmt.Fprintln(os.Stderr, "problem unmarshalling data.", err) 151 | } 152 | 153 | var add = true 154 | 155 | // retrieve a map from the structure and write it out to the 156 | // bolt db. 157 | lmap := storeStruct(ls, js) 158 | if len(lmap) > 0 { 159 | makeIDIndex(kb, lmap) 160 | 161 | lmapid := convertInterface(lmap["id"]) 162 | for x := range id { 163 | if lmapid == id[x] { 164 | add = false 165 | log.Println("Already seen:", lmap["filename"], lmap["title"]) 166 | break 167 | } 168 | } 169 | if add { 170 | makeIDIndex(kb, lmap) 171 | id = append(id, lmapid) 172 | } 173 | } 174 | } 175 | -------------------------------------------------------------------------------- /bolthandler_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | /* Example JSON: 4 | { 5 | "FileName": "bbc news", 6 | "AnalysisVersionNumber": "0.0.0", 7 | "AnalysisVersionText": "exponentialDK-httpreserve/0.0.0", 8 | "Link": "http://www.bbc.co.uk/news", 9 | "ResponseCode": 200, 10 | "ResponseText": "OK", 11 | "ScreenShot": "", 12 | "InternetArchiveLinkLatest": "http://web.archive.org/web/20170328040059/http://www.bbc.co.uk/news/", 13 | "InternetArchiveLinkEarliest": "http://web.archive.org/web/19971009011901/http://www.bbc.co.uk/news/", 14 | "InternetArchiveSaveLink": "http://web.archive.org/save/http://www.bbc.co.uk/news", 15 | "InternetArchiveResponseCode": 200, 16 | "InternetArchiveResponseText": "OK", 17 | "Archived": true, 18 | "ProtocolError": false, 19 | "ProtocolErrorMessage": "" 20 | }, 21 | */ 22 | 23 | /* 24 | filename:bbc home 25 | id:891609239375c54fe326a2e23a8c5397 26 | 27 | filename:bbc radio 28 | id:1d15698856a2487bade7d8994d21d30c 29 | 30 | filename:tna 31 | id:3357924f215d974f627690dd6382076c 32 | 33 | id:43d4a499caa590e912c8a059f7ab8323 34 | filename:bbc news */ 35 | 36 | /* 37 | //for now, for testing... 38 | var linkmap = map[string]string{ 39 | "http://www.bbc.co.uk/news": "bbc news", 40 | "http://www.bbc.co.uk/": "bbc home", 41 | "http://www.bbc.co.uk/radio": "bbc radio", 42 | "http://www.nationalarchives.gov.uk/": "tna", 43 | } 44 | */ 45 | -------------------------------------------------------------------------------- /csvhandler.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "os" 7 | "strings" 8 | 9 | "github.com/httpreserve/httpreserve" 10 | ) 11 | 12 | var csvHeader = []string{"id", "filename", "link", "response code", "response text", "title", 13 | "content-type", 14 | "archived", "internet archive response code", "internet archive response text", 15 | "wayback earliest date", "internet archive earliest", 16 | "wayback latest date", "internet archive latest", "internet archive save link", 17 | "protocol error", "protocol error", 18 | "analysis version number", "analysis version text", "stats creation time"} 19 | 20 | func outputCSVHeader() string { 21 | var header string 22 | header = "\"" + strings.Join(csvHeader, "\",\"") + "\"" + "\n" 23 | return header 24 | } 25 | 26 | func outputCSVRow(lmap map[string]interface{}) string { 27 | var row []string 28 | for x := range csvHeader { 29 | if val, ok := lmap[csvHeader[x]]; ok { 30 | var v string 31 | switch val.(type) { 32 | case string: 33 | v = fmt.Sprintf("%s", val) 34 | v = strings.Replace(v, "\"", "'", -1) 35 | v = fmt.Sprintf("\"%s\"", v) 36 | case int: 37 | v = fmt.Sprintf("\"%d\"", val) 38 | case bool: 39 | v = fmt.Sprintf("\"%t\"", val) 40 | } 41 | row = append(row, v) 42 | } else { 43 | row = append(row, "\"\"") 44 | } 45 | } 46 | return strings.Join(row, ",") 47 | } 48 | 49 | // TODO: consider more idiomatic approaches to achieving what we do here, 50 | // that is, fmt.Println() is not really my approved approach (but it works) 51 | func csvHandler(js string) { 52 | var ls httpreserve.LinkStats 53 | err := json.Unmarshal([]byte(js), &ls) 54 | if err != nil { 55 | fmt.Fprintln(os.Stderr, "problem unmarshalling data.", err) 56 | } 57 | 58 | // retrieve a map from the structure and write it out to the CSV 59 | lmap := storeStruct(ls, js) 60 | if len(lmap) > 0 { 61 | fmt.Fprintf(os.Stdout, "%s\n", outputCSVRow(lmap)) 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /datacopier.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import "github.com/httpreserve/httpreserve" 4 | 5 | // This structure is used to communicate with the server 6 | // we may also use some static storage in the form of Bolt DB 7 | // the final signal to the webapp will be a empty payload 8 | // but with the complete flag set to true so that we know there 9 | // is no more work to be processed. ls contains a link stat 10 | // data structure if we can recreate one from the JSON we receive 11 | // else the js variable will contain a single JSON document to 12 | // be processed. 13 | type processLog struct { 14 | complete bool 15 | ls httpreserve.LinkStats 16 | js string 17 | lmap map[string]interface{} 18 | } 19 | 20 | // Thread safe data copy from one slice to another 21 | func tsdatacopy(copyfrom *int, copyto *int, list []string) []string { 22 | //protect memory by copying only what we know we've got 23 | *copyto = len(list) 24 | if *copyto > 0 && *copyto > *copyfrom { 25 | var res []string 26 | res = make([]string, *copyto-*copyfrom) 27 | copy(res, list[*copyfrom:*copyto]) 28 | *copyfrom = *copyto 29 | return res 30 | } 31 | return []string{} 32 | } 33 | 34 | // Thread safe data copy from one slice to another 35 | func pldatacopy(copyfrom *int, copyto *int, list []processLog) []processLog { 36 | //protect memory by copying only what we know we've got 37 | *copyto = len(list) 38 | if *copyto > 0 && *copyto > *copyfrom { 39 | var res []processLog 40 | res = make([]processLog, *copyto-*copyfrom) 41 | copy(res, list[*copyfrom:*copyto]) 42 | *copyfrom = *copyto 43 | return res 44 | } 45 | return []processLog{} 46 | } 47 | 48 | // Thread safe data copy from one slice to another 49 | // This method allows us to specify a length which may be safer for 50 | // us in the long run... 51 | func pldatacopylen(copyfrom *int, copyto *int, list []processLog) []processLog { 52 | //protect memory by copying only what we know we've got 53 | *copyto = *copyto + 1 54 | if *copyto > 0 && *copyto > *copyfrom && *copyto <= len(list) { 55 | var res []processLog 56 | res = make([]processLog, *copyto-*copyfrom) 57 | copy(res, list[*copyfrom:*copyto]) 58 | *copyfrom = *copyto 59 | return res 60 | } 61 | return []processLog{} 62 | } 63 | -------------------------------------------------------------------------------- /distil.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -eux 3 | 4 | MOONSHINE="linkstat" 5 | DIR="release" 6 | VERSION="${MOONSHINE}" 7 | rm -rf "$DIR" 8 | mkdir -p "$DIR" 9 | export GOOS=windows 10 | export GOARCH=386 11 | go build 12 | mv "$MOONSHINE".exe "${DIR}/${VERSION}"-win386.exe 13 | export GOOS=windows 14 | export GOARCH=amd64 15 | go build 16 | mv "$MOONSHINE".exe "${DIR}/${VERSION}"-win64.exe 17 | export GOOS=linux 18 | export GOARCH=amd64 19 | go build 20 | mv "$MOONSHINE" "${DIR}/${VERSION}"-linux64 21 | export GOOS= 22 | export GOARCH=386 23 | go build 24 | mv "$MOONSHINE" "${DIR}/${VERSION}"-darwin386 25 | export GOOS=darwin 26 | export GOARCH=amd64 27 | go build 28 | mv "$MOONSHINE" "${DIR}/${VERSION}"-darwinAmd64 29 | export GOOS= 30 | export GOARCH= 31 | -------------------------------------------------------------------------------- /example.csv: -------------------------------------------------------------------------------- 1 | "BBC News", "http://www.bbc.co.uk/news" 2 | "BBC Home", "http://www.bbc.co.uk/" 3 | "BBC Radio", "http://www.bbc.co.uk/radio" 4 | "Google", "http://www.google.com" 5 | "exponentialdecay.co.uk", "http://www.exponentialdecay.co.uk" 6 | "Internet Archive", "http://www.archive.org" 7 | "perma.cc", "http://perma.cc" 8 | "wikipedia.org", "http://wikipedia.org" 9 | "The Million Dollar Homepage", "http://www.getpixel.net" 10 | "Ravensburger Blog", "https://community.ravensburger.de/t5/Puzzle-Blog/Dieser-Sommer/ba-p/8735 11 | "Wonderforge", "http://wonderforge.com/" 12 | "Ravensburger Puzzle World", "https://urlz.fr/lxe8" 13 | "Ravensburger Puzzle World", "https://is.gd/5WrcId" 14 | "Ravensburger Puzzle World", "https://t.ly/ZG-1P" 15 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/httpreserve/linkstat 2 | 3 | go 1.20 4 | 5 | require ( 6 | github.com/httpreserve/httpreserve v0.0.15 7 | github.com/httpreserve/wayback v0.0.0-20211222152933-14b2302c807b 8 | github.com/kval-access-language/kval-bbolt v0.0.0-20230420120231-8c2fbba90834 9 | github.com/speps/go-hashids v2.0.0+incompatible 10 | ) 11 | 12 | require ( 13 | github.com/google/uuid v1.3.0 // indirect 14 | github.com/httpreserve/phantomjsscreenshot v0.0.0-20180422150311-c763ac7abadc // indirect 15 | github.com/httpreserve/simplerequest v0.0.0-20170904111322-6f325573aa95 // indirect 16 | github.com/justinas/alice v1.2.0 // indirect 17 | github.com/kval-access-language/kval-parse v0.0.0-20170504112528-b96aa5a26330 // indirect 18 | github.com/kval-access-language/kval-scanner v0.0.0-20170504112421-4f097cacd289 // indirect 19 | github.com/pkg/errors v0.9.1 // indirect 20 | go.etcd.io/bbolt v1.3.7 // indirect 21 | golang.org/x/sys v0.4.0 // indirect 22 | ) 23 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 2 | github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= 3 | github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= 4 | github.com/httpreserve/httpreserve v0.0.0-20211222164930-89a61e1ec671 h1:9glz6wyd6VucjsaB2TUdNg/iqc42LlGKPDEhrE5zOK8= 5 | github.com/httpreserve/httpreserve v0.0.0-20211222164930-89a61e1ec671/go.mod h1:eJtlc1pSh1dD76qNfx16veUlX1jMbV+oRkgyQr/R+cY= 6 | github.com/httpreserve/httpreserve v0.0.0-20230421144733-96d037c541b0 h1:BZyP7e55FkDQu1AYJWnt1e521PRXfYHSU8BjYKJ2I2Y= 7 | github.com/httpreserve/httpreserve v0.0.0-20230421144733-96d037c541b0/go.mod h1:eJtlc1pSh1dD76qNfx16veUlX1jMbV+oRkgyQr/R+cY= 8 | github.com/httpreserve/httpreserve v0.0.0-20230526152046-0fbb8bcef27d h1:qu2r0hADGmADwwZ11I9MqWZ8V2Z9+QO3R5tByEDZc5E= 9 | github.com/httpreserve/httpreserve v0.0.0-20230526152046-0fbb8bcef27d/go.mod h1:eJtlc1pSh1dD76qNfx16veUlX1jMbV+oRkgyQr/R+cY= 10 | github.com/httpreserve/httpreserve v0.0.15 h1:/Wpt0F8WXcU1UFHGt/GcQ/UKOZTU64k+I2ic3FbLjhE= 11 | github.com/httpreserve/httpreserve v0.0.15/go.mod h1:eJtlc1pSh1dD76qNfx16veUlX1jMbV+oRkgyQr/R+cY= 12 | github.com/httpreserve/phantomjsscreenshot v0.0.0-20180422150311-c763ac7abadc h1:QSH5I52X/qdPuJcWK4pymLQWHc+Pp2IEvvAqLE7Xhk4= 13 | github.com/httpreserve/phantomjsscreenshot v0.0.0-20180422150311-c763ac7abadc/go.mod h1:5buv8evqeUmXcW01Gmdjgqs5ttSySQXQOFiRgCAMP+U= 14 | github.com/httpreserve/simplerequest v0.0.0-20170904111322-6f325573aa95 h1:c6ci9fUN0o3SB1kI6N9Nn8L+/pAlrCzvJhXOKprSS9g= 15 | github.com/httpreserve/simplerequest v0.0.0-20170904111322-6f325573aa95/go.mod h1:1gggeoGjBdclzVr/HfTjL6AtLe6ei+2oNjVT++aZacw= 16 | github.com/httpreserve/wayback v0.0.0-20170426121002-5a35a28d33c2/go.mod h1:FSVvr4AY9Pwn7jmqLZyInQa/F4YBB5/R2OEHeG3dq9U= 17 | github.com/httpreserve/wayback v0.0.0-20211222152933-14b2302c807b h1:S7pFXjREHPrL3rjBoC/8E9JO9eTrysebv6Tx2+4PZ50= 18 | github.com/httpreserve/wayback v0.0.0-20211222152933-14b2302c807b/go.mod h1:8hce7RnzFjn69in/4cIigV/xQoKpp9PrW3yqAwT7dds= 19 | github.com/justinas/alice v1.2.0 h1:+MHSA/vccVCF4Uq37S42jwlkvI2Xzl7zTPCN5BnZNVo= 20 | github.com/justinas/alice v1.2.0/go.mod h1:fN5HRH/reO/zrUflLfTN43t3vXvKzvZIENsNEe7i7qA= 21 | github.com/kval-access-language/kval-bbolt v0.0.0-20230420120231-8c2fbba90834 h1:sVU026dXc58HHSxki2Ln7j4a4PNvFrN4vNCa6k4DAE8= 22 | github.com/kval-access-language/kval-bbolt v0.0.0-20230420120231-8c2fbba90834/go.mod h1:tJu8VsdoIgrXevcL5Dzo+3iEy/enB8goeQAgUMY1sLM= 23 | github.com/kval-access-language/kval-parse v0.0.0-20170504112528-b96aa5a26330 h1:u+bu63lKw/77wcyhzRB9YwipGEa4l3et/hu4xkcX2cQ= 24 | github.com/kval-access-language/kval-parse v0.0.0-20170504112528-b96aa5a26330/go.mod h1:sIViryZLFGwtty1cz01GVfqCzHR2j5O7ZCcuYiGJAJA= 25 | github.com/kval-access-language/kval-scanner v0.0.0-20170504112421-4f097cacd289 h1:xp6dE/eMUsoTqp/A4p846HSDlETgYPcW+gmtSW7G0tc= 26 | github.com/kval-access-language/kval-scanner v0.0.0-20170504112421-4f097cacd289/go.mod h1:YAawD4QhDnNbLB6455T6SheCYnZh90kII4jhq5HWzAQ= 27 | github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= 28 | github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 29 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 30 | github.com/speps/go-hashids v2.0.0+incompatible h1:kSfxGfESueJKTx0mpER9Y/1XHl+FVQjtCqRyYcviFbw= 31 | github.com/speps/go-hashids v2.0.0+incompatible/go.mod h1:P7hqPzMdnZOfyIk+xrlG1QaSMw+gCBdHKsBDnhpaZvc= 32 | github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= 33 | go.etcd.io/bbolt v1.3.7 h1:j+zJOnnEjF/kyHlDDgGnVL/AIqIJPq8UoB2GSNfkUfQ= 34 | go.etcd.io/bbolt v1.3.7/go.mod h1:N9Mkw9X8x5fupy0IKsmuqVtoGDyxsaDlbk4Rd05IAQw= 35 | golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18= 36 | golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 37 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 38 | -------------------------------------------------------------------------------- /httpresponse_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | //e,g, test the table output formatter 4 | -------------------------------------------------------------------------------- /jsonhandler.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "sync" 7 | ) 8 | 9 | func outputJSONHeader() string { 10 | var header string 11 | header = header + fmt.Sprintf("%s\n", "{") 12 | header = header + fmt.Sprintf(" \"%s\": \"%s\",\n", "title", "httpreserve-linkstat") 13 | header = header + fmt.Sprintf(" \"%s\": \"%s\",\n", "description", "httpreserve-linkstat-output") 14 | header = header + fmt.Sprintf(" \"%s\": %s\n", "data", "[") 15 | return header 16 | } 17 | 18 | func outputJSONFooter() string { 19 | var footer string 20 | footer = footer + fmt.Sprintf("%s\n%s\n", "]", "}") 21 | return footer 22 | } 23 | 24 | var jsonCount int 25 | 26 | // webappHanlder enables us to establish the web server and create 27 | // the structures we need to present our data to the user... 28 | func jsonHandler(js string) { 29 | wg := new(sync.WaitGroup) 30 | wg.Add(1) 31 | go makejsonpool(js, wg) 32 | wg.Wait() 33 | return 34 | } 35 | 36 | var jsonpool []string 37 | 38 | func makejsonpool(js string, wg *sync.WaitGroup) { 39 | defer wg.Done() 40 | jsonpool = append(jsonpool, js) 41 | } 42 | 43 | func outputjsonpool() { 44 | for j := range jsonpool { 45 | if j+1 < len(jsonpool) { 46 | fmt.Fprint(os.Stdout, jsonpool[j]+",") 47 | } else { 48 | fmt.Fprint(os.Stdout, jsonpool[j]) 49 | } 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /justfile: -------------------------------------------------------------------------------- 1 | # CLI helpers. 2 | 3 | # help 4 | help: 5 | @echo "Command line helpers for this project.\n" 6 | @just -l 7 | 8 | # Run go linting 9 | linting: 10 | goimports -w . 11 | go fmt . 12 | - go vet . 13 | - staticcheck . 14 | 15 | # Run pre-commit 16 | all-checks: 17 | pre-commit run --all-files 18 | 19 | # Compile for all platforms 20 | compile-all: 21 | ./distil.sh 22 | 23 | # Setup linting 24 | setup: 25 | go install golang.org/x/tools/cmd/goimports@latest 26 | go install honnef.co/go/tools/cmd/staticcheck@latest 27 | 28 | # Fix imports 29 | fix-imports: 30 | goimports -w . 31 | -------------------------------------------------------------------------------- /linkstat.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "log" 7 | "os" 8 | "time" 9 | 10 | "github.com/httpreserve/httpreserve" 11 | ) 12 | 13 | var ( 14 | //version 15 | vers bool 16 | 17 | //individual links 18 | link string 19 | label string 20 | 21 | //output methods 22 | boltdb bool 23 | jsonout bool 24 | csvout bool 25 | 26 | //list processing 27 | list string 28 | ) 29 | 30 | func init() { 31 | // Return version information. 32 | flag.BoolVar(&vers, "version", false, "Return httpreserve version.") 33 | flag.BoolVar(&vers, "v", false, "Return httpreserve version.") 34 | 35 | // Flags to return a single result. 36 | flag.StringVar(&link, "link", "", "Seek the status of a single URL: JSON") 37 | flag.StringVar(&label, "label", "", "Annotate single URL check response with label.") 38 | 39 | // Flags to batch results. 40 | flag.StringVar(&list, "list", "", "Provide a list of URLs to test against in CSV format.") 41 | 42 | // Output method flags. 43 | flag.BoolVar(&boltdb, "bolt", false, "Output to static BoltDB.") 44 | flag.BoolVar(&jsonout, "json", false, "Output to JSON.") 45 | flag.BoolVar(&csvout, "csv", false, "Output to CSV.") 46 | } 47 | 48 | func getJSONFromLocal(link string, label string) string { 49 | ls, err := httpreserve.GenerateLinkStats(link, label, true) 50 | if err != nil { 51 | log.Println("Error retrieving linkstat JSON may be incorrect:", err) 52 | } 53 | js := httpreserve.MakeLinkStatsJSON(ls) 54 | 55 | // throttle requests to the server somehow... 56 | time.Sleep(500 * time.Millisecond) 57 | 58 | // return json... 59 | return js 60 | } 61 | 62 | func getLocalLink() { 63 | js := getJSONFromLocal(link, label) 64 | fmt.Fprintln(os.Stderr, "Using httpreserve libs to retrieve data.") 65 | fmt.Fprintf(os.Stdout, "%s", js) 66 | } 67 | 68 | var htmcomplete bool 69 | var starttime time.Time 70 | var elapsedtime time.Duration 71 | 72 | func programrunner() { 73 | if jsonout { 74 | fmt.Fprintf(os.Stdout, "%s", outputJSONHeader()) 75 | listHandler(jsonHandler) 76 | outputjsonpool() 77 | fmt.Fprintf(os.Stdout, "%s", outputJSONFooter()) 78 | return 79 | } 80 | if csvout { 81 | //output JSON header 82 | fmt.Fprintf(os.Stdout, "%s", outputCSVHeader()) 83 | listHandler(csvHandler) 84 | return 85 | } 86 | if boltdb { 87 | openKVALBolt() 88 | defer closeKVALBolt() 89 | listHandler(boltdbHandler) 90 | return 91 | } 92 | if link != "" { 93 | getLocalLink() 94 | } 95 | } 96 | 97 | func main() { 98 | flag.Parse() 99 | if vers { 100 | fmt.Fprintf(os.Stderr, "%s\n", getVersion()) 101 | fmt.Fprintf(os.Stderr, "%s\n", httpreserve.VersionText()) 102 | os.Exit(0) 103 | } else if flag.NFlag() <= 0 { 104 | fmt.Fprintln(os.Stderr, "Usage: linkstat [Optional -link] [Optional -label]") 105 | fmt.Fprintln(os.Stderr, " [Optional -list] [Optional -json]") 106 | fmt.Fprintln(os.Stderr, " [Optional -bolt]") 107 | fmt.Fprintln(os.Stderr, " [Optional -csv]") 108 | fmt.Fprintln(os.Stderr, " [Optional -version -v]") 109 | fmt.Fprintln(os.Stderr, "") 110 | fmt.Fprintln(os.Stderr, "Output: [Json]") 111 | fmt.Fprintln(os.Stderr, "Output: [CSV]") 112 | fmt.Fprintln(os.Stderr, "Output: [BoltDB]") 113 | fmt.Fprintf(os.Stderr, "Output: [Version] '%s ...'\n", httpreserve.VersionText()) 114 | fmt.Fprintln(os.Stderr, "") 115 | flag.Usage() 116 | os.Exit(0) 117 | } 118 | programrunner() 119 | } 120 | -------------------------------------------------------------------------------- /linkstathandler.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "crypto/md5" 5 | "fmt" 6 | 7 | "github.com/httpreserve/httpreserve" 8 | "github.com/httpreserve/wayback" 9 | ) 10 | 11 | var structids []string 12 | 13 | // makeHash will create a MD5 hash for us to use to index our data without 14 | // duplication... 15 | func makeHash(js string) string { 16 | md5 := md5.New() 17 | md5.Write([]byte(js)) 18 | return fmt.Sprintf("%x", md5.Sum(nil)) 19 | } 20 | 21 | // convertInterface will help us pipe generic values from 22 | // the deconstruction of httpreserve.LinkStats to a string for 23 | // storage in BoltDB. 24 | func convertInterface(v interface{}) string { 25 | var val string 26 | switch v.(type) { 27 | case string: 28 | val = fmt.Sprintf("%s", v) 29 | case int: 30 | val = fmt.Sprintf("%d", v) 31 | case bool: 32 | switch v { 33 | case true: 34 | val = "true" 35 | case false: 36 | val = "false" 37 | } 38 | } 39 | if val == "" { 40 | return "\"\"" 41 | } 42 | return val 43 | } 44 | 45 | // storeStruct allows us to get a different representation of the LinkStats structure 46 | // e.g. as a map we have good flexibility over looping and passing around without 47 | // reglection to iterate through the struct for us. 48 | func storeStruct(ls httpreserve.LinkStats, js string) map[string]interface{} { 49 | var lmap = make(map[string]interface{}) 50 | // make an id to help filtering in reports, 51 | // id should be unique to the JSON output 52 | id := makeHash(js) 53 | lmap["id"] = id 54 | lmap["filename"] = ls.FileName 55 | lmap["content-type"] = ls.ContentType 56 | lmap["title"] = ls.Title 57 | lmap["analysis version number"] = ls.AnalysisVersionNumber 58 | lmap["analysis version text"] = ls.AnalysisVersionText 59 | lmap["link"] = ls.Link 60 | lmap["response code"] = ls.ResponseCode 61 | lmap["response text"] = ls.ResponseText 62 | lmap["internet archive latest"] = ls.InternetArchiveLinkLatest 63 | lmap["internet archive earliest"] = ls.InternetArchiveLinkEarliest 64 | lmap["wayback latest date"] = wayback.GetHumanDate(ls.InternetArchiveLinkLatest) 65 | lmap["wayback earliest date"] = wayback.GetHumanDate(ls.InternetArchiveLinkEarliest) 66 | lmap["internet archive save link"] = ls.InternetArchiveSaveLink 67 | lmap["internet archive response code"] = ls.InternetArchiveResponseCode 68 | lmap["internet archive response text"] = ls.InternetArchiveResponseText 69 | lmap["archived"] = ls.Archived 70 | lmap["protocol error"] = ls.Error 71 | lmap["protocol error"] = ls.ErrorMessage 72 | lmap["stats creation time"] = ls.StatsCreationTime 73 | return lmap 74 | } 75 | -------------------------------------------------------------------------------- /listprocessor.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "fmt" 6 | "os" 7 | "strings" 8 | "sync" 9 | ) 10 | 11 | var pscomplete = false 12 | 13 | // list handler to help us kick off some go channels 14 | // we pass a first class function to help route our output 15 | func listHandler(outputHandler func(js string)) { 16 | 17 | link := make(chan map[string]string) 18 | results := make(chan string) 19 | 20 | wg := new(sync.WaitGroup) 21 | 22 | // batches of two... helps us to batch out work, e.g. to throttle 23 | // server requests... two requests per second, IN THEORY! 24 | for w := 0; w <= 2; w++ { 25 | wg.Add(1) 26 | go getJSON(link, results, wg) 27 | } 28 | 29 | // Create a link map for output to the output handlers 30 | go func() { 31 | // Read all the lines in a file... 32 | file, err := os.Open(list) 33 | if err != nil { 34 | fmt.Fprintf(os.Stderr, "Error with scanner: %s\n", err.Error()) 35 | } 36 | defer file.Close() 37 | 38 | scanner := bufio.NewScanner(file) 39 | for scanner.Scan() { 40 | l := make(map[string]string) 41 | row := scanner.Text() 42 | var split []string 43 | if strings.Contains(row, "\",\"") { 44 | split = strings.Split(scanner.Text(), "\",\"") 45 | } else if strings.Contains(row, "\", \"") { 46 | split = strings.Split(scanner.Text(), "\", \"") 47 | } else { 48 | split = strings.Split(scanner.Text(), ",") 49 | } 50 | if len(split) != 2 { 51 | fmt.Fprintf(os.Stderr, "ignoring: issue reading string from file: %s\n", scanner.Text()) 52 | } else { 53 | l[strings.Trim(split[1], " ")] = strings.Trim(split[0], " ") 54 | link <- l 55 | } 56 | } 57 | 58 | if err := scanner.Err(); err != nil { 59 | fmt.Fprintf(os.Stderr, "Error with scanner: %s\n", scanner.Text()) 60 | } 61 | close(link) 62 | }() 63 | 64 | go func() { 65 | wg.Wait() 66 | pscomplete = true 67 | linklen++ 68 | close(results) 69 | }() 70 | 71 | for js := range results { 72 | outputHandler(js) 73 | } 74 | } 75 | 76 | var linklen int 77 | 78 | func getJSON(link <-chan map[string]string, results chan<- string, wg *sync.WaitGroup) { 79 | defer wg.Done() 80 | for m := range link { 81 | // k filename, v link... 82 | for k, v := range m { 83 | k = strings.Trim(k, "\"") 84 | v = strings.Trim(v, "\"") 85 | results <- getJSONFromLocal(k, v) 86 | } 87 | } 88 | } 89 | 90 | // retrieve a JSON output from HTTPreserve without talking to the server 91 | func httpreserveJSONOutput(link string, filename string) string { 92 | js := getJSONFromLocal(link, filename) 93 | return js 94 | } 95 | -------------------------------------------------------------------------------- /version.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | var version = "httpreserve-linkstat-0.0.3" 4 | 5 | func getVersion() string { 6 | return version 7 | } 8 | --------------------------------------------------------------------------------