From 52d12a4fa124daa1595529e3e7008276a7986d95 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Mon, 13 Jun 2022 11:06:49 +0200 Subject: unfinished partial work --- doc/man/man1/hydrilla-builder.1 | 94 +++++ doc/uml/classes.uxf | 759 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 853 insertions(+) create mode 100644 doc/man/man1/hydrilla-builder.1 create mode 100644 doc/uml/classes.uxf (limited to 'doc') diff --git a/doc/man/man1/hydrilla-builder.1 b/doc/man/man1/hydrilla-builder.1 new file mode 100644 index 0000000..f58ab97 --- /dev/null +++ b/doc/man/man1/hydrilla-builder.1 @@ -0,0 +1,94 @@ +.\" SPDX-License-Identifier: CC0-1.0 +.\" +.\" Man page for Hydrilla builder. +.\" +.\" Copyright (C) 2022 Wojtek Kosior +.\" +.\" Available under the terms of Creative Commons Zero v1.0 Universal. + +.TH HYDRILLA-BUILDER 1 2022-04-22 "Hydrilla 1.0" "Hydrilla Manual" + +.SH NAME +hydrilla-builder \- Generate packages to be served by Hydrilla + +.SH SYNOPSIS +.B "hydrilla\-builder \-\-help" +.br +.B "hydrilla\-builder [\-s \fISOURCE\/\fP] [\-i\ \fIINDEX_PATH\/\fP]" +.B "\-d \fIDESTINATION\/\fP" +.br +(See the OPTIONS section for alternate option syntax with long option +names.) + +.SH DESCRIPTION +.I hydrilla-builder +is a tool which takes a Hydrilla source package and generates files of a +built package, suitable for serving by the Hydrilla server. + +As of Hydrilla version 1.0 +.I hydrilla-builder +does not yet perform nor trigger actions like compilation, minification or +bundling of source code files. Its main function is to automate the process +of computing SHA256 cryptographic sums of package files and including them +in JSON definitions. + +In addition, +.B hydrilla\-builder +can generate an SPDX report from source package if the +\*(lqreuse_generate_spdx_report\*(rq property is set to true in index.json. + +.SH OPTIONS +.TP +.B \-\^\-help +Output a usage message and exit. + +.TP +.BI \-s " SOURCE" "\fR,\fP \-\^\-srcdir=" SOURCE +Use +.I SOURCE +as source package directory to build from. +If not specified, current directory is used. + +.TP +.BI \-i " INDEX_PATH" "\fR,\fP \-\^\-index\-json=" INDEX_PATH +Process the JSON file under +.I INDEX_PATH +instead of index.json inside source directory. +.I INDEX_PATH +may be either absolute or relative. +In the latter case it is resolved with respect to the source directory. + +File provided as +.I INDEX_PATH +will also be included in the generated source archive as +\*(lqindex.json\*(rq, substituting any file with such name that could be +present in the source directory. + +.TP +.BI \-d " DESTINATION" "\fR,\fP \-\^\-dstdir=" DESTINATION +Write generated files under +.IR DESTINATION . +Files are written in such way that +.I DESTINATION +is valid for being passed to Hydrilla to serve packages from. + +.TP +.B \-\^\-version +Show version information for this instance of +.I hydrilla-builder +on the standard output and exit successfully. + +.SH "EXIT STATUS" +The exit status is 0 if build was performed successfully or if the +.B \-\^\-help +option was passed. It is a number different from 0 in all other cases. + +.SH "SEE ALSO" +.SS "Manual Pages" +.BR hydrilla (1). + +.SS "Full Documentation" +.UR https://hydrillabugs.koszko.org/projects/hydrilla/wiki +Online documentation +.UE +is available on Hydrilla issue tracker. diff --git a/doc/uml/classes.uxf b/doc/uml/classes.uxf new file mode 100644 index 0000000..1dcbb56 --- /dev/null +++ b/doc/uml/classes.uxf @@ -0,0 +1,759 @@ + + + 8 + + UMLClass + + 248 + 80 + 128 + 32 + + hydrilla.proxy.addon. +HaketiloAddon + + + + + UMLClass + + 384 + 320 + 184 + 32 + + hydrilla.pattern_tree. +PatternTree[Policy] + + + + + UMLClass + + 288 + 200 + 176 + 32 + + hydrilla.proxy.state. +HaketiloState + + + + Relation + + 336 + 104 + 24 + 112 + + lt=<<<<- +m1=1 +m2=1 + 10.0;10.0;10.0;120.0 + + + Relation + + 424 + 224 + 24 + 112 + + lt=<<<<- +m1=1 +m2=1 + + 10.0;10.0;10.0;120.0 + + + UMLClass + + 560 + 384 + 136 + 32 + + /hydrilla.proxy.policies./ +/Policy/ + + + + + Relation + + 536 + 320 + 112 + 80 + + lt=[URL pattern]-> +m2=1..* + + + 40.0;20.0;100.0;20.0;100.0;80.0 + + + UMLNote + + 400 + 32 + 152 + 32 + + Receives&processes events from mitmproxy. + + + + Relation + + 368 + 56 + 48 + 40 + + lt=. + 10.0;30.0;40.0;10.0 + + + UMLNote + + 624 + 88 + 136 + 48 + + Keeps track of all rules, mappings and resources. + + + + Relation + + 456 + 120 + 184 + 96 + + lt=. + 10.0;100.0;210.0;10.0 + + + UMLClass + + 416 + 768 + 136 + 32 + + hydrilla.proxy.policies. +PayloadPolicy + + + + UMLClass + + 416 + 528 + 136 + 32 + + /hydrilla.proxy.policies./ +/BlockPolicy/ + + + + UMLClass + + 416 + 672 + 136 + 32 + + /hydrilla.proxy.policies./ +/AllowPolicy/ + + + + UMLClass + + 416 + 720 + 136 + 32 + + hydrilla.proxy.policies. +MetaResourcePolicy + + + + Relation + + 544 + 408 + 120 + 392 + + lt=<<. + 130.0;10.0;130.0;470.0;10.0;470.0 + + + Relation + + 544 + 408 + 104 + 344 + + lt=<<. + 110.0;10.0;110.0;410.0;10.0;410.0 + + + Relation + + 544 + 408 + 88 + 296 + + lt=<<. + 90.0;10.0;90.0;350.0;10.0;350.0 + + + Relation + + 544 + 408 + 72 + 152 + + lt=<<. + 70.0;10.0;70.0;170.0;10.0;170.0 + + + Relation + + 328 + 728 + 104 + 24 + + lt=<<<<- + 10.0;10.0;110.0;10.0 + + + UMLClass + + 168 + 720 + 168 + 32 + + hydrilla.proxy.flow_handlers. +FlowHandlerMetaResource + + + + Relation + + 488 + 352 + 256 + 504 + + lt=<<<<- +m1=1 +m2=1 + 10.0;560.0;10.0;610.0;300.0;610.0;300.0;10.0 + + + UMLClass + + 648 + 328 + 192 + 32 + + hydrilla.item_infos. +MappingInfo + + + + UMLClass + + 576 + 176 + 232 + 32 + + hydrilla.item_infos. +VersionedItemInfo[MappingInfo] + + + + Relation + + 432 + 208 + 160 + 56 + + lt=[repository]-> +m2=1..* + + + 40.0;10.0;100.0;10.0;100.0;40.0;180.0;40.0 + + + UMLClass + + 576 + 224 + 232 + 32 + + hydrilla.item_infos. +VersionedItemInfo[ResourceInfo] + + + + Relation + + 504 + 184 + 88 + 48 + + lt=-> +m2=1..* + + + 10.0;40.0;10.0;10.0;90.0;10.0 + + + UMLClass + + 648 + 280 + 192 + 32 + + hydrilla.item_infos. +ResourceInfo + + + + Relation + + 784 + 184 + 160 + 184 + + lt=[version]-> +m2=1..* + 30.0;10.0;180.0;10.0;180.0;200.0;70.0;200.0 + + + Relation + + 784 + 232 + 128 + 88 + + lt=[version]-> +m2=1..* + + + 30.0;10.0;140.0;10.0;140.0;80.0;70.0;80.0 + + + Relation + + 336 + 536 + 96 + 24 + + lt=<<<<- + 10.0;10.0;100.0;10.0 + + + UMLClass + + 176 + 528 + 168 + 32 + + hydrilla.proxy.flow_handlers. +FlowHandlerBlockScripts + + + + Relation + + 328 + 680 + 104 + 24 + + lt=<<<<- + 10.0;10.0;110.0;10.0 + + + UMLClass + + 168 + 672 + 168 + 32 + + hydrilla.proxy.flow_handlers. +FlowHandlerAllowScripts + + + + Relation + + 328 + 776 + 104 + 24 + + lt=<<<<- + 10.0;10.0;110.0;10.0 + + + UMLClass + + 168 + 768 + 168 + 32 + + hydrilla.proxy.flow_handlers. +FlowHandlerInjectPayload + + + + UMLClass + + 8 + 304 + 168 + 32 + + /hydrilla.proxy.flow_handlers./ +/FlowHandler/ + + + + Relation + + 104 + 328 + 88 + 232 + + lt=<<. + 10.0;10.0;10.0;270.0;90.0;270.0 + + + Relation + + 88 + 328 + 96 + 376 + + lt=<<. + 10.0;10.0;10.0;450.0;100.0;450.0 + + + Relation + + 72 + 328 + 112 + 424 + + lt=<<. + 10.0;10.0;10.0;510.0;120.0;510.0 + + + Relation + + 56 + 328 + 128 + 472 + + lt=<<. + 10.0;10.0;10.0;570.0;140.0;570.0 + + + Relation + + 48 + 80 + 216 + 240 + + lt=<. +<<instantiates>> + + + + + + + + + + + + + + + + + 10.0;280.0;10.0;10.0;250.0;10.0 + + + UMLClass + + 296 + 432 + 136 + 32 + + hydrilla.proxy.policies. +FallbackBlockPolicy + + + + Relation + + 480 + 456 + 24 + 88 + + lt=<<. + 10.0;90.0;10.0;10.0 + + + UMLClass + + 152 + 432 + 136 + 32 + + hydrilla.proxy.policies. +ErrorBlockPolicy + + + + Relation + + 360 + 456 + 144 + 56 + + lt=. + 160.0;50.0;10.0;50.0;10.0;10.0 + + + UMLClass + + 440 + 432 + 136 + 32 + + hydrilla.proxy.policies. +RuleBlockPolicy + + + + Relation + + 216 + 456 + 168 + 56 + + lt=. + 190.0;50.0;10.0;50.0;10.0;10.0 + + + UMLClass + + 296 + 576 + 136 + 32 + + hydrilla.proxy.policies. +FallbackAllowPolicy + + + + Relation + + 360 + 600 + 144 + 56 + + lt=. + 160.0;50.0;10.0;50.0;10.0;10.0 + + + UMLClass + + 440 + 576 + 136 + 32 + + hydrilla.proxy.policies. +RuleAllowPolicy + + + + Relation + + 480 + 600 + 24 + 88 + + lt=<<. + 10.0;90.0;10.0;10.0 + + + UMLNote + + 616 + 40 + 144 + 32 + + Facilitates storing and modifying data on-disk. + + + + Relation + + 584 + 48 + 48 + 48 + + lt=. + 10.0;40.0;40.0;10.0 + + + UMLClass + + 432 + 80 + 160 + 32 + + hydrilla.proxy.store. +HaketiloStore + + + + Relation + + 440 + 104 + 24 + 112 + + lt=<<- + 10.0;10.0;10.0;120.0 + + + UMLClass + + 248 + 272 + 88 + 24 + + lt=. +StateUpdater + + + + Relation + + 136 + 264 + 128 + 56 + + lt=<. +<<produces>> + 140.0;20.0;10.0;20.0;10.0;50.0 + + + Relation + + 312 + 224 + 64 + 64 + + lt=<. +<<uses>> + 10.0;10.0;10.0;60.0 + + + Relation + + 256 + 104 + 64 + 184 + + lt=<. +<<uses>> + + + + + + + 10.0;210.0;10.0;10.0 + + + UMLNote + + 136 + 176 + 96 + 24 + + Function type + + + + Relation + + 184 + 192 + 80 + 96 + + lt=. + 80.0;100.0;10.0;10.0 + + -- cgit v1.2.3