id
stringlengths
4
5
content
stringlengths
35
470
layer
stringclasses
3 values
summary
float64
FR01
FR 1 - Any software tool or application based on libwarc shall require just a single header file.
Functional Requirement
null
FR02
FR 2 - The libwarc interfaces shall fully encapsulate and internal functionality, isolating by abstraction any tool or application based on libwarc from changes in the internal implementation.
Functional Requirement
null
FR03
FR 3 - Libwarc shall provide a range of functions through a universal interface for creating each type of valid WARC-record, thus ensuring the resulting WARC files conform to the prevailing WARC standard
Functional Requirement
null
FR04
FR 4 - For each type of WARC-record, a set of functions shall be made available to create/modify the records properties.
Functional Requirement
null
FR05
FR 5 - Libwarc shall provide a range of functions through a universal interface for reading a range of valid WARC-records
Functional Requirement
null
FR06
FR 6 - Libwarc shall provide a stable Application Programme Interface (API) to handle WARCrecords as abstract objects (ADT)
Functional Requirement
null
FR07
FR 7 - Libwarc shall provide ARC-record reader functionality Libwarc reader will thereby make read operations as simple as possible.
Functional Requirement
null
FR08
FR 8 - Libwarc shall provide a default iterator as a built-in function
Functional Requirement
null
FR09
FR 9 - Libwarc shall provide a records iterator to handle WARC-type records
Functional Requirement
null
FR10
FR 10 - Libwarc shall provide a MIMES iterator to handle MIME-types payloads
Functional Requirement
null
FR11
FR 11 - Iterators can use exact pattern search or regex expressions
Functional Requirement
null
FR12
FR 12 - Libwarc shall provide an abstract interface for iterators, to enable custom iterators
Functional Requirement
null
FR13
FR 13 - Libwarc shall enable combinations of iterators to be used, i.e. composite iterators
Functional Requirement
null
FR14
FR 14 - Libwarc shall be memory safe and manage dynamic memory internally
Functional Requirement
null
FR15
FR 15 - Libwarc shall use disk-based working memory
Functional Requirement
null
FR16
FR 16 - Dynamic memory management shall be hidden inside libwarc
Functional Requirement
null
FR17
FR 17 - Libwarc shall use gzip as the default compression format
Functional Requirement
null
FR18
FR 18 - Libwarc shall provide a plug-in interface to enable use of alternative compression libraries, such as "gzip2", "7zip", etc.
Functional Requirement
null
FR19
FR 19 - Libwarc shall manage all write and read access
Functional Requirement
null
FR20
FR 20 - WARC files shall be validated using a command line tool, "w-validator", which will enable validation or rejection of WARC files.
Functional Requirement
null
FR21
FR 21 - WARC Browser shall provide an API that allows browsing of WARC files and associated CDX files via an HTTP server
Functional Requirement
null
FR22
FR 22 - WARC Browser shall support a rewriting interface
Functional Requirement
null
FR23
FR 23 - WARC Browser shall support a proxy-style interface
Functional Requirement
null
FR24
FR 24 - An Apache and Lighttp plug-in shall provide access to the libwarc API and WARC Browser over http
Functional Requirement
null
FR25
FR 25 - It shall be possible to convert ARC files to WARC files using a command-line tool called "arc2warc"
Functional Requirement
null
FR26
FR 26 - ARC to WARC conversions made by arc2warc shall be carried out according to a specification in a configuration file
Functional Requirement
null
FR27
FR 27 - It shall be possible to collect HTTrack data from the directories output by HTTrack and write the data to WARC files
Functional Requirement
null
FR28
FR 28 - It shall be possible to walk a wget mirror and write the data to WARC files
Functional Requirement
null
FR29
FR 29 - It shall be possible to walk a curl directory and write the data to WARC files
Functional Requirement
null
FR30
FR 30 - It shall be possible to collect arbitrary web content, such as html files, images etc. (for example from a web server document root directory), and write the data to WARC files
Functional Requirement
null
FR31
FR 31 - A Python script shall be made available to enable rapid development of WARC based solutions
Functional Requirement
null
FR32
FR 32 - WARC extensions shall be released as a patch to each of the commands "curl", "wget", and "httrack" projects
Functional Requirement
null
FR33
FR 33 - WARC extensions help content will be provided each of the commands "curl", "wget", and "httrack"
Functional Requirement
null
FR34
FR 34 - It shall be possible to identify WARC files using the unix "file" command
Functional Requirement
null
FR35
FR 35 - It shall be possible to identify and validate WARC files using "Jhove"
Functional Requirement
null
FR36
FR 36 - A Jhove plugin module and an output handler shall be made available for WARC files
Functional Requirement
null
FR37
FR 37 - WARC files in various test-states shall be provided that test the Jhove deliverables
Functional Requirement
null
FR38
FR 38 - The C library shall be implemented to be compatible with the Simplified Wrapper and Interface Generator (SWIG, http://www.swig.org) - a wrapper for libwarc C code to allow it to be called natively in a wide variety of languages.
Functional Requirement
null
FR39
FR 39 - A Python interface shall be implemented
Functional Requirement
null
FR40
FR 40 - A Java interface shall be implemented
Functional Requirement
null
FR41
FR 41 - An independent Java implementation of libwarc may be implemented
Functional Requirement
null
FR42
FR 42 - The functionality of the library shall be exposed in such a way as to fit the metaphors and paradigms of the implementation language
Functional Requirement
null
SRS01
SRS 1 - There shall be a single entry point to libwarc, called "warc.h".
Specification
null
SRS02
SRS 2 - The "libwarc" headers shall be structured in a hierarchical manner. The universal header "warc.h" will include all of them.
Specification
null
SRS03
SRS 3 - It shall be possible for developers to access, modify and manipulate of all aspects of the WARC file format by including this single header file.
Specification
null
SRS04
SRS 4 - The universal header "warc.h" shall ensure compatibility between all versions of libwarc.
Specification
null
SRS05
SRS 5 - The universal header "warc.h" shall ensure that deprecated function calls and changes to the library are notified at compile time.
Specification
null
SRS06
SRS 6 - The interfaces in libwarc shall ensure that any changes to the library, will not affect any tool or application based on libwarc.
Specification
null
SRS07
SRS 7 - The universal header "warc.h" shall provide normalised interfaces to enable developers to create valid and compliant WARC-records, based on the definition in the "ISO TC 46/SC 4 N 595" standards document. The interfaces shall be made available to create WARC records of the following types: - "warinfo" - "response" - "request" - "metadata" - "revisit" - "conversion" - "continuation" - "resource"
Specification
null
SRS08
SRS 8 - Each WARC-record shall be accessible via a peer C class of the same name.
Specification
null
SRS09
SRS 9 - The attributes of each WARC-record, as per the ISO standard specification, shall have a corresponding attribute in its peer C class.
Specification
null
SRS10
SRS 10 - Each peer class shall expose a set a class functions to read, write, and update attributes for the corresponding WARC-record.
Specification
null
SRS11
SRS 11 - Libwarc shall provide an API describing (1) the set of data, and (2) the set of operations that can be performed on the data. The data types shall be abstract (abstract data types - ADT), to ensure independence of concrete implementations.
Specification
null
SRS12
SRS 12 - It shall be possible to create a WARC-record using a constructor, which will returns an abstract handle to data representing the WARC-record.
Specification
null
SRS13
SRS 13 - It shall be possible to release the WARC-record using a destructor.
Specification
null
SRS14
SRS 14 - Any operations on WARC-records shall be possible using functions accepting the abstract handle as an argument.
Specification
null
SRS15
SRS 15 -Libwarc shall include ADT objects to handle read operations on ARC-records
Specification
null
SRS16
SRS 16 - Libwarc shall provide a generic iterator, to enable the developer to iterate over all WARCrecords and create an abstract WARC-document as a simple container
Specification
null
SRS17
SRS 17 - Libwarc shall provide a WARC-record MIME-type iterator
Specification
null
SRS18
SRS 18 - Libwarc shall provide a WARC-record-type iterator
Specification
null
SRS19
SRS 19 - Libwarc's generic iterators may be customised for different purposes via callback handlers (i.e. hooks)
Specification
null
SRS20
SRS 20 - Libwarc's iterators may be combined into composite iterators to enable the developer to more than one search field
Specification
null
SRS21
SRS 21 - Libwarc shall encapsulate and handle all memory management when processing WARCrecords.
Specification
null
SRS22
SRS 22 - Developers using libwarc shall not be required to allocate/release memory directly, instead the developer shall use libwarc's object constructor and destructor functions.
Specification
null
SRS23
SRS 23 - Libwarc shall use dynamic heap memory for its internal usage.
Specification
null
SRS24
SRS 24 - Libwarc shall allocate minimum memory heap to store WARC-record metadata.
Specification
null
SRS25
SRS 25 - The payload (or the WARC-record document itself) are stored on disk, to avoid using memory heap, even for small objects.
Specification
null
SRS26
SRS 26 - Libwarc shall not use file to memory mapping technology, instead libwarc will explicitly allocate memory as needed.
Specification
null
SRS27
SRS 27 - Libwarc shall support non-compressed WARC-records and compressed WARC-records and files
Specification
null
SRS28
SRS 28 - The default compression format shall be Gzip
Specification
null
SRS29
SRS 29 - Libwarc shall support multiple compression schemas, loading a specific compressor at runtime as an external shared library.
Specification
null
SRS30
SRS 30 - It shall not be possible to use more than one compression schema (including noncompression) within a single WARC file. (i.e. it is not possible to mix compression schemes within a single WARC file).
Specification
null
SRS31
SRS 31 - A command line tool shall be implemented utilising libwarc to check the consistency of WARC-records and their conformance to the WARC ISO standard.
Specification
null
SRS32
SRS 32 - The command line tool shall notify the user of any WARC-record's anomalies, missing required fields or incompatible fields types.
Specification
null
SRS33
SRS 33 - Libwarc shall provide a set of classes to enable remote management of WARC-records
Specification
null
SRS34
SRS 34 - It shall be possible to perform read operations (read from offset, filters, etc.) on WARCrecords from a remote location via http.
Specification
null
SRS35
SRS 35 - For security reasons, it shall not be possible to perform write or update operations on a WARC-record remotely
Specification
null
SRS36
SRS 36 - WARC browser shall not support CDX files because the CDX file format is not a standard at this time and is outside of scope.
Specification
null
SRS37
SRS 37 - WARC Browser shall support a client-side rewriting interface by using javascript code to rewrite links being delivered alongside archived content. This is based on the principles implemented in the Wayback Machine.
Specification
null
SRS38
SRS 38 -A web proxy interface shall be implemented that allows the user to set their web browser proxy to the one provided by the interface and thereby ensure all content is delivered from the archive and not from the live web.
Specification
null
SRS39
SRS 39 - Libwarc shall be incorporated within an Apache module to enable all actions specified in SRS 34-36 to be executed within Apache.
Specification
null
SRS40
SRS 40 - Libwarc shall be incorporated within a Lighttp module to enable all actions specified in SRS 34-36 to be executed within lighttp.
Specification
null
SRS41
SRS 41 - A command line tool "arc2warc" incorporating libwarc shall be able to migrate data in ARC-records to WARC-record format.
Specification
null
SRS42
SRS 42 - The default operation of "arc2warc" shall carry out a one-to-one mapping of record fields, by converting each ARC-record to a corresponding "response" WARC-record and "metadata" WARCrecord, which shall include information about the conversion process.
Specification
null
SRS43
SRS 43 - "arc2warc" shall have make a default operation in cases where an ARC-record has no corresponding field in the WARC-record.
Specification
null
SRS44
SRS 44 - It shall be possible to specify non-default operations of "arc2warc" using a named configuration file, which will describe the desired ARC-record to WARC-record conversion.
Specification
null
SRS45
SRS 45 - A set of command line tools incorporating libwarc shall perform migration of "HTTrack" archives to WARC-records.
Specification
null
SRS46
SRS 46 - The HTTrack archive file format and link strategy may vary from version to version of HTTrack, therefore it shall be possible to adapt the migration scripts to deal with these changes.
Specification
null
SRS47
SRS 47 - A set of command line tools incorporating libwarc shall perform migration of "wget" archives to WARC-records.
Specification
null
SRS48
SRS 48 - A set of command line tools incorporating libwarc shall perform migration of "curl" archives to WARC-records.
Specification
null
SRS49
SRS 49 - A set of command line tools and an API incorporating libwarc shall enable the collection of online documents, such as html and embedded files, etc., and write them to valid WARC- records.
Specification
null
SRS50
SRS 50 - The command line tools and API in SRS 50 will not include any links extraction features.
Specification
null
SRS51
SRS 51 - Python scripts shall be implemented incorporating libwarc, and making all of the functionality of libwarc and API available in Python.
Specification
null
SRS52
SRS 52 - Extensions to "HTTrack", "wget" and "curl" incorporating libwarc shall be provided as patches to recent and specific versions of each tool, to enable users of the tool to access functionality of libwarc
Specification
null
SRS53
SRS 53 - Helper documentation for libwarc functionality shall be made available within the "HTTrack", "wget" and "curl" commands.
Specification
null
SRS54
SRS 54 - A magic number for WARC shall be created and incorporated in the "file" mime-type database, enabling the simple identification of WARC files via the Unix "file" command
Specification
null
SRS55
SRS 55 - The WARC validator tool specified in SRS 31-32 shall be extended to optionally make use of the Jhove command line API to identify and validate WARC files, i.e. given a specific WARC file, this command shall be able to identify the file as a WARC file, validate the level of compliance with a given standard in terms of well-formedness and validity, and finally to characterise the file by extracting and displaying significant properties contained in the file.
Specification
null
SRS56
SRS 56 - WarcMdoule and WarcHandler plugin modules shall be implemented for Jhove Plugin layer to enable identification and validation of WARC files.
Specification
null
SRS57
SRS 57 - WARC files in various test-states shall be provided that test the Jhove deliverables
Specification
null
SRS58
SRS 58 - Void, duplicate of SRS 79
Specification
null