Merge pull request #36 from simon987/wip-doc

Wip doc

.gitignore

@@ -15,3 +15,4 @@ bundle*.css
 bundle.js
 *.a
 vgcore.*
+build/

.gitmodules

@@ -31,15 +31,15 @@
 [submodule "lib/mupdf"]
 	path = lib/mupdf
 	url = git://git.ghostscript.com/mupdf.git
-[submodule "lib/zstd"]
-	path = lib/zstd
-	url = https://github.com/facebook/zstd
-[submodule "lib/lz4"]
-	path = lib/lz4
-	url = https://github.com/lz4/lz4
-[submodule "lib/libarchive"]
-	path = lib/libarchive
-	url = https://github.com/libarchive/libarchive
-[submodule "lib/libxml2"]
-	path = lib/libxml2
-	url = https://github.com/GNOME/libxml2
+[submodule "lib/tesseract"]
+	path = lib/tesseract
+	url = https://github.com/tesseract-ocr/tesseract
+[submodule "lib/leptonica"]
+	path = lib/leptonica
+	url = https://github.com/danbloomberg/leptonica
+[submodule "lib/libtiff"]
+	path = lib/libtiff
+	url = https://gitlab.com/libtiff/libtiff
+[submodule "lib/libpng"]
+	path = lib/libpng
+	url = https://github.com/glennrp/libpng

.teamcity/settings.kts

@@ -0,0 +1,69 @@
+import jetbrains.buildServer.configs.kotlin.v2019_2.*
+import jetbrains.buildServer.configs.kotlin.v2019_2.buildSteps.ExecBuildStep
+import jetbrains.buildServer.configs.kotlin.v2019_2.buildSteps.exec
+import jetbrains.buildServer.configs.kotlin.v2019_2.triggers.vcs
+import jetbrains.buildServer.configs.kotlin.v2019_2.vcs.GitVcsRoot
+
+/*
+The settings script is an entry point for defining a TeamCity
+project hierarchy. The script should contain a single call to the
+project() function with a Project instance or an init function as
+an argument.
+
+VcsRoots, BuildTypes, Templates, and subprojects can be
+registered inside the project using the vcsRoot(), buildType(),
+template(), and subProject() methods respectively.
+
+To debug settings scripts in command-line, run the
+
+    mvnDebug org.jetbrains.teamcity:teamcity-configs-maven-plugin:generate
+
+command and attach your debugger to the port 8000.
+
+To debug in IntelliJ Idea, open the 'Maven Projects' tool window (View
+-> Tool Windows -> Maven Projects), find the generate task node
+(Plugins -> teamcity-configs -> teamcity-configs:generate), the
+'Debug' option is available in the context menu for the task.
+*/
+
+version = "2019.2"
+
+project {
+
+    vcsRoot(HttpsGithubComSimon987sist2refsHeadsMaster)
+
+    buildType(Build)
+}
+
+object Build : BuildType({
+    name = "Build"
+
+    artifactRules = """
+        sist2
+        sist2_scan
+    """.trimIndent()
+
+    vcs {
+        root(HttpsGithubComSimon987sist2refsHeadsMaster)
+    }
+
+    steps {
+        exec {
+            name = "Build"
+            path = "./ci/build.sh"
+            dockerImage = "simon987/general_ci"
+            dockerImagePlatform = ExecBuildStep.ImagePlatform.Linux
+            dockerPull = true
+        }
+    }
+
+    triggers {
+        vcs {
+        }
+    }
+})
+
+object HttpsGithubComSimon987sist2refsHeadsMaster : GitVcsRoot({
+    name = "https://github.com/simon987/sist2#refs/heads/master"
+    url = "https://github.com/simon987/sist2"
+})

CMakeLists.txt

@@ -1,95 +1,59 @@
 cmake_minimum_required(VERSION 3.7)
 set(CMAKE_C_STANDARD 11)
 
-option(WITH_SIST2 "Build main executable" ON)
-option(WITH_SIST2_SCAN "Build scan executable" ON)
-
 project(sist2 C)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/CMakeModules")
 
-if (WITH_SIST2)
-    add_executable(
-            sist2
-            src/main.c
-            src/sist.h
-            src/io/walk.h src/io/walk.c
-            src/parsing/media.h src/parsing/media.c
-            src/parsing/pdf.h src/parsing/pdf.c
-            src/io/store.h src/io/store.c
-            src/tpool.h src/tpool.c
-            src/parsing/parse.h src/parsing/parse.c
-            src/io/serialize.h src/io/serialize.c
-            src/parsing/mime.h src/parsing/mime.c src/parsing/mime_generated.c
-            src/parsing/text.h src/parsing/text.c
-            src/index/web.c src/index/web.h
-            src/web/serve.c src/web/serve.h
-            src/web/auth_basic.h src/web/auth_basic.c
-            src/index/elastic.c src/index/elastic.h
-            src/util.c src/util.h
-            src/ctx.h src/types.h src/parsing/font.c src/parsing/font.h
+option(SIST_DEBUG "Build a debug executable" on)
 
-            # argparse
-            argparse/argparse.h argparse/argparse.c
+add_executable(
+        sist2
+        src/main.c
+        src/sist.h
+        src/io/walk.h src/io/walk.c
+        src/parsing/media.h src/parsing/media.c
+        src/parsing/pdf.h src/parsing/pdf.c
+        src/io/store.h src/io/store.c
+        src/tpool.h src/tpool.c
+        src/parsing/parse.h src/parsing/parse.c
+        src/io/serialize.h src/io/serialize.c
+        src/parsing/mime.h src/parsing/mime.c src/parsing/mime_generated.c
+        src/parsing/text.h src/parsing/text.c
+        src/index/web.c src/index/web.h
+        src/web/serve.c src/web/serve.h
+        src/web/auth_basic.h src/web/auth_basic.c
+        src/index/elastic.c src/index/elastic.h
+        src/util.c src/util.h
+        src/ctx.h src/types.h src/parsing/font.c src/parsing/font.h
+        src/parsing/arc.c src/parsing/arc.h
+        src/parsing/doc.c src/parsing/doc.h
+        src/log.c src/log.h
+        src/parsing/cbr.h src/parsing/cbr.c
 
-            # cJSON
-            cJSON/cJSON.h cJSON/cJSON.c
+        # argparse
+        argparse/argparse.h argparse/argparse.c
 
-            # LMDB
-            lmdb/libraries/liblmdb/lmdb.h lmdb/libraries/liblmdb/mdb.c
-            lmdb/libraries/liblmdb/midl.h lmdb/libraries/liblmdb/midl.c
-            src/cli.c src/cli.h
+        # cJSON
+        cJSON/cJSON.h cJSON/cJSON.c
 
-            # utf8.h
-            utf8.h/utf8.h
-            src/parsing/arc.c src/parsing/arc.h src/parsing/doc.c src/parsing/doc.h)
-endif ()
+        # LMDB
+        lmdb/libraries/liblmdb/lmdb.h lmdb/libraries/liblmdb/mdb.c
+        lmdb/libraries/liblmdb/midl.h lmdb/libraries/liblmdb/midl.c
+        src/cli.c src/cli.h
 
-if (WITH_SIST2_SCAN)
-    add_executable(
-            sist2_scan
-            src/main.c
-            src/sist.h
-            src/io/walk.h src/io/walk.c
-            src/parsing/media.h src/parsing/media.c
-            src/parsing/pdf.h src/parsing/pdf.c
-            src/io/store.h src/io/store.c
-            src/tpool.h src/tpool.c
-            src/parsing/parse.h src/parsing/parse.c
-            src/io/serialize.h src/io/serialize.c
-            src/parsing/mime.h src/parsing/mime.c src/parsing/mime_generated.c
-            src/parsing/text.h src/parsing/text.c
-            src/util.c src/util.h
-            src/ctx.h src/types.h src/parsing/font.c src/parsing/font.h
-
-            # argparse
-            argparse/argparse.h argparse/argparse.c
-
-            # cJSON
-            cJSON/cJSON.h cJSON/cJSON.c
-
-            # LMDB
-            lmdb/libraries/liblmdb/lmdb.h lmdb/libraries/liblmdb/mdb.c
-            lmdb/libraries/liblmdb/midl.h lmdb/libraries/liblmdb/midl.c
-            src/cli.c src/cli.h
-
-            # utf8.h
-            utf8.h/utf8.h
-            src/parsing/arc.c src/parsing/arc.h src/parsing/doc.c src/parsing/doc.h)
-endif ()
+        # utf8.h
+        utf8.h/utf8.h
+)
 
 find_package(PkgConfig REQUIRED)
 set(ENV{PKG_CONFIG_PATH} "$ENV{PKG_CONFIG_PATH}:/usr/local/lib/pkgconfig/")
 
-find_package(LibMagic REQUIRED)
-find_package(FFmpeg REQUIRED)
-find_package(OpenSSL REQUIRED)
 find_package(Freetype REQUIRED)
 
 pkg_check_modules(GLIB REQUIRED glib-2.0)
 pkg_check_modules(GOBJECT REQUIRED gobject-2.0)
 pkg_check_modules(UUID REQUIRED uuid)
 
-add_definitions(${LIBMAGIC_CFLAGS_OTHER})
 add_definitions(${UUID_CFLAGS_OTHER})
 add_definitions(${GLIB_CFLAGS_OTHER})
 add_definitions(${GOBJECT_CFLAGS_OTHER})
@@ -99,166 +63,113 @@ list(REMOVE_ITEM GLIB_LIBRARIES pcre)
 list(REMOVE_ITEM GOBJECT_LIBRARIES pcre)
 list(REMOVE_ITEM UUID_LIBRARIES pcre)
 
-if (WITH_SIST2)
-    target_include_directories(
-            sist2 PUBLIC
-            ${LIBMAGIC_INCLUDE_DIRS}
-            ${GOBJECT_INCLUDE_DIRS}
-            ${OPENSSL_INCLUDE_DIR}
-            ${FFMPEG_INCLUDE_DIRS}
-            ${GLIB_INCLUDE_DIRS}
-            ${FREETYPE_INCLUDE_DIRS}
-            ${UUID_INCLUDE_DIRS}
-            ${PROJECT_SOURCE_DIR}/
-            ${PROJECT_SOURCE_DIR}/lmdb/libraries/liblmdb/
-            ${PROJECT_SOURCE_DIR}/lib/onion/src/
-            ${PROJECT_SOURCE_DIR}/lib/mupdf/include/
-            ${PROJECT_SOURCE_DIR}/include/
-            /usr/include/libxml2/
-    )
-    target_link_directories(
-            sist2 PUBLIC
-            ${UUID_LIBRARY_DIRS}
-            ${FFMPEG_LIBRARY_DIRS}
-    )
+target_include_directories(
+        sist2 PUBLIC
+        ${GOBJECT_INCLUDE_DIRS}
+        ${GLIB_INCLUDE_DIRS}
+        ${PROJECT_SOURCE_DIR}/lib/ffmpeg/
+        ${FREETYPE_INCLUDE_DIRS}
+        ${UUID_INCLUDE_DIRS}
+        ${PROJECT_SOURCE_DIR}/
+        ${PROJECT_SOURCE_DIR}/lmdb/libraries/liblmdb/
+        ${PROJECT_SOURCE_DIR}/lib/onion/src/
+        ${PROJECT_SOURCE_DIR}/lib/mupdf/include/
+        ${PROJECT_SOURCE_DIR}/include/
+        /usr/include/libxml2/
+        ${PROJECT_SOURCE_DIR}/lib/tesseract/include/
+)
+target_link_directories(
+        sist2 PUBLIC
+        ${UUID_LIBRARY_DIRS}
+)
 
+target_compile_options(
+        sist2
+        PRIVATE
+        -fPIC
+)
 
-    target_compile_options(sist2
-            PRIVATE
-            -Ofast
-#                    -march=native
-            -fno-stack-protector
-            -fomit-frame-pointer
-            )
-
-    TARGET_LINK_LIBRARIES(
+if (SIST_DEBUG)
+    target_compile_options(
             sist2
-
-            ${GLIB_LIBRARIES}
-            ${GOBJECT_LIBRARIES}
-            ${UUID_LIBRARIES}
-
-            # ffmpeg
-            ${PROJECT_SOURCE_DIR}/lib/libavcodec.a
-            ${PROJECT_SOURCE_DIR}/lib/libavformat.a
-            ${PROJECT_SOURCE_DIR}/lib/libavutil.a
-            ${PROJECT_SOURCE_DIR}/lib/libswscale.a
-            ${PROJECT_SOURCE_DIR}/lib/libswresample.a
-            #        ${FFMPEG_LIBRARIES}
-            #        swscale
-
-            # mupdf
-            ${PROJECT_SOURCE_DIR}/lib/libmupdf.a
-            ${PROJECT_SOURCE_DIR}/lib/libmupdf-third.a
-
-            # onion
-            ${PROJECT_SOURCE_DIR}/lib/libonion_static.a
-
-            pthread
-            curl
-            m
-            bz2
-            magic
-            ${PROJECT_SOURCE_DIR}/lib/libharfbuzz.a
-            ${PROJECT_SOURCE_DIR}/lib/libopenjp2.a
-            freetype
-            archive
-
-#            ${PROJECT_SOURCE_DIR}/lib/libxml2.a
-            xml2
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libmce.a
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libopc.a
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libplib.a
+            PRIVATE
+            -g
+            -fstack-protector
+            -fno-omit-frame-pointer
+            -fsanitize=address
     )
-
-endif ()
-
-if (WITH_SIST2_SCAN)
-
-    set_target_properties(
-            sist2_scan
-            PROPERTIES COMPILE_DEFINITIONS SIST_SCAN_ONLY
+    target_link_options(
+            sist2
+            PRIVATE
+            -fsanitize=address
     )
     set_target_properties(
-            sist2_scan
+            sist2
             PROPERTIES
-            COMPILE_DEFINITIONS SIST_SCAN_ONLY
-            LINK_FLAGS -static
+            OUTPUT_NAME sist2_debug
     )
-    target_include_directories(
-            sist2_scan PUBLIC
-            ${LIBMAGIC_INCLUDE_DIRS}
-            ${GOBJECT_INCLUDE_DIRS}
-            ${OPENSSL_INCLUDE_DIR}
-            ${FFMPEG_INCLUDE_DIRS}
-            ${GLIB_INCLUDE_DIRS}
-            ${UUID_INCLUDE_DIRS}
-            ${FREETYPE_INCLUDE_DIRS}
-            ${PROJECT_SOURCE_DIR}/
-            ${PROJECT_SOURCE_DIR}/lmdb/libraries/liblmdb/
-            ${PROJECT_SOURCE_DIR}/lib/onion/src/
-            ${PROJECT_SOURCE_DIR}/lib/mupdf/include/
-            ${PROJECT_SOURCE_DIR}/include/
-            /usr/include/libxml2/
-    )
-    target_link_directories(
-            sist2_scan PUBLIC
-            ${UUID_LIBRARY_DIRS}
-            ${FFMPEG_LIBRARY_DIRS}
-    )
-    target_compile_options(sist2_scan
+else ()
+    target_compile_options(
+            sist2
             PRIVATE
             -Ofast
-            #        -march=native
             -fno-stack-protector
             -fomit-frame-pointer
-            )
-    TARGET_LINK_LIBRARIES(
-            sist2_scan
-
-            ${GLIB_LIBRARIES}
-            ${GOBJECT_LIBRARIES}
-            ${UUID_LIBRARIES}
-
-            # ffmpeg
-            ${PROJECT_SOURCE_DIR}/lib/libavcodec.a
-            ${PROJECT_SOURCE_DIR}/lib/libavformat.a
-            ${PROJECT_SOURCE_DIR}/lib/libavutil.a
-            ${PROJECT_SOURCE_DIR}/lib/libswscale.a
-            ${PROJECT_SOURCE_DIR}/lib/libswresample.a
-
-            # mupdf
-            ${PROJECT_SOURCE_DIR}/lib/libmupdf.a
-            ${PROJECT_SOURCE_DIR}/lib/libmupdf-third.a
-
-            ${PROJECT_SOURCE_DIR}/lib/libbz2.a
-            ${PROJECT_SOURCE_DIR}/lib/libmagic.a
-
-            pthread
-            m
-            ${PROJECT_SOURCE_DIR}/lib/libharfbuzz.a
-            ${PROJECT_SOURCE_DIR}/lib/libopenjp2.a
-            freetype
-
-            ${PROJECT_SOURCE_DIR}/lib/libarchive.a
-            ${PROJECT_SOURCE_DIR}/lib/liblz4.a
-            ${PROJECT_SOURCE_DIR}/lib/liblzma.a
-            ${PROJECT_SOURCE_DIR}/lib/libzstd.a
-
-            ${PROJECT_SOURCE_DIR}/lib/libxml2.a
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libmce.a
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libopc.a
-            ${PROJECT_SOURCE_DIR}/lib/libopc/libplib.a
     )
 endif ()
 
+TARGET_LINK_LIBRARIES(
+        sist2
+
+        ${GLIB_LIBRARIES}
+        ${GOBJECT_LIBRARIES}
+        ${UUID_LIBRARIES}
+
+        # ffmpeg
+        ${PROJECT_SOURCE_DIR}/lib/libavcodec.a
+        ${PROJECT_SOURCE_DIR}/lib/libavformat.a
+        ${PROJECT_SOURCE_DIR}/lib/libavutil.a
+        ${PROJECT_SOURCE_DIR}/lib/libswscale.a
+        ${PROJECT_SOURCE_DIR}/lib/libswresample.a
+
+        # mupdf
+        ${PROJECT_SOURCE_DIR}/lib/libmupdf.a
+        ${PROJECT_SOURCE_DIR}/lib/libmupdf-third.a
+
+        # onion
+        ${PROJECT_SOURCE_DIR}/lib/libonion_static.a
+
+        pthread
+
+        m
+        bz2
+#        ${PROJECT_SOURCE_DIR}/lib/libmagic.a
+        magic
+        ${PROJECT_SOURCE_DIR}/lib/libharfbuzz.a
+        ${PROJECT_SOURCE_DIR}/lib/libopenjp2.a
+        freetype
+        archive
+
+        xml2
+
+        ${PROJECT_SOURCE_DIR}/lib/libtesseract.a
+        ${PROJECT_SOURCE_DIR}/lib/liblept.a
+        ${PROJECT_SOURCE_DIR}/lib/libtiff.a
+        ${PROJECT_SOURCE_DIR}/lib/libpng16.a
+        stdc++
+
+        # curl
+        ${PROJECT_SOURCE_DIR}/lib/libcurl.a
+        ${PROJECT_SOURCE_DIR}/lib/libcrypto.a
+        ${PROJECT_SOURCE_DIR}/lib/libssl.a
+        dl
+
+        pcre
+)
+
 add_custom_target(
         before_sist2
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/scripts/before_build.sh
 )
 
-IF (WITH_SIST2)
-    add_dependencies(sist2 before_sist2)
-else ()
-    add_dependencies(sist2_scan before_sist2)
-endif ()
+add_dependencies(sist2 before_sist2)

Docker/Dockerfile

@@ -2,8 +2,21 @@ FROM ubuntu:19.10
 MAINTAINER simon987 <me@simon987.net>
 
 RUN apt update
-RUN apt install -y libglib2.0-0 libcurl4 libmagic1 libharfbuzz-bin libopenjp2-7 libarchive13 liblzma5 libzstd1 liblz4-1
+RUN apt install -y libglib2.0-0 libcurl4 libmagic1 libharfbuzz-bin libopenjp2-7 libarchive13 liblzma5 libzstd1 liblz4-1 \
+ curl libtiff5 libpng16-16 libpcre3
+
+RUN mkdir -p /usr/share/tessdata && \
+    cd /usr/share/tessdata/ && \
+    curl -o /usr/share/tessdata/hin.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/hin.traineddata &&\
+    curl -o /usr/share/tessdata/jpn.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/jpn.traineddata &&\
+    curl -o /usr/share/tessdata/eng.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/eng.traineddata &&\
+    curl -o /usr/share/tessdata/fra.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/fra.traineddata &&\
+    curl -o /usr/share/tessdata/rus.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/rus.traineddata &&\
+    curl -o /usr/share/tessdata/spa.traineddata https://raw.githubusercontent.com/tesseract-ocr/tessdata/master/spa.traineddata && ls -lh
 
 ADD sist2 /root/sist2
 
-ENTRYPOINT ["/root/sist2"]
+ENV LANG C.UTF-8
+ENV LC_ALL C.UTF-8
+
+ENTRYPOINT ["/root/sist2"]

Docker/build.sh

@@ -1,9 +1,15 @@
 rm ./sist2
 cp ../sist2 .
+strip sist2
 
 version=$(./sist2 --version)
 
 echo "Version ${version}"
-docker build . -t simon987/sist2:${version} -t simon987/sist2:latest
+docker build . -t simon987/sist2:${version} -t simon987/sist2:latest \
+  -t docker.pkg.github.com/simon987/sist2/sist2:latest -t docker.pkg.github.com/simon987/sist2/sist2:${version}
 docker push simon987/sist2:${version}
 docker push simon987/sist2:latest
+docker push docker.pkg.github.com/simon987/sist2/sist2:latest
+docker push docker.pkg.github.com/simon987/sist2/sist2:${version}
+
+docker run --rm -it simon987/sist2 -v

README.md

@@ -1,5 +1,6 @@
 ![GitHub](https://img.shields.io/github/license/simon987/sist2.svg)
 [![CodeFactor](https://www.codefactor.io/repository/github/simon987/sist2/badge?s=05daa325188aac4eae32c786f3d9cf4e0593f822)](https://www.codefactor.io/repository/github/simon987/sist2)
+[![Development snapshots](https://ci.simon987.net/app/rest/builds/buildType(Sist2_Build)/statusIcon)](https://files.simon987.net/artifacts/Sist2/Build/)
 
 # sist2
 
@@ -7,88 +8,70 @@ sist2 (Simple incremental search tool)
 
 *Warning: sist2 is in early development*
 
+![sist2.png](sist2.png)
+
 ## Features
 
 * Fast, low memory usage, multi-threaded
+* Mobile-friendly Web interface
 * Portable (all its features are packaged in a single executable)
-* Extracts text from common file types\*
-* Generates thumbnails\*
+* Extracts text from common file types \*
+* Generates thumbnails \*
 * Incremental scanning
 * Automatic tagging from file attributes via [user scripts](scripting/README.md)
 * Recursive scan inside archive files \*\*
+* OCR support with tesseract \*\*\*
 
 
 \* See [format support](#format-support)    
-\** See [Archive files](#archive-files)
+\*\* See [Archive files](#archive-files)    
+\*\*\* See [OCR](#ocr)    
 
 ## Getting Started
 
-1. Have an [Elasticsearch](https://www.elastic.co/downloads/elasticsearch) instance running
-1. 
+1. Have an Elasticsearch (>= 6.X.X) instance running
+    1. Download [from official website](https://www.elastic.co/downloads/elasticsearch)
+    1. *(or)* Run using docker:
+        ```bash
+       docker run -d --name es1 --net sist2_net -p 9200:9200 \
+            -e "discovery.type=single-node" elasticsearch:7.5.2
+        ```
+    1. *(or)* Run using docker-compose:
+        ```yaml
+          elasticsearch:
+            image: docker.elastic.co/elasticsearch/elasticsearch:7.5.2
+            environment:
+              - discovery.type=single-node
+              - "ES_JAVA_OPTS=-Xms1G -Xmx2G"
+        ```
+1. Download sist2 executable
     1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases) *
+    1. *(or)* Download a [development snapshot](https://files.simon987.net/artifacts/Sist2/Build/) *(Not recommended!)*
     1. *(or)* `docker pull simon987/sist2:latest`
+
+1. See [Usage guide](USAGE.md)
    
 
 \* *Windows users*: **sist2** runs under [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)    
-\* *Mac users*: See [#1](https://github.com/simon987/sist2/issues/1)
 
 
 ## Example usage
 
-See help page `sist2 --help` for more details.
+See [Usage guide](USAGE.md) for more details
 
-**Scan a directory**
-```bash
-sist2 scan ~/Documents -o ./orig_idx/
-sist2 scan --threads 4 --content-size 16384 /mnt/Pictures
-sist2 scan --incremental ./orig_idx/ -o ./updated_idx/ ~/Documents
-```
-
-**Push index to Elasticsearch or file**
-```bash
-sist2 index --force-reset ./my_idx
-sist2 index --print ./my_idx > raw_documents.ndjson
-```
-
-**Start web interface**
-```bash
-sist2 web --bind 0.0.0.0 --port 4321 ./my_idx1 ./my_idx2 ./my_idx3
-```
-
-### Use sist2 with docker
-
-**scan**
-```bash
-docker run -it \
-    -v /path/to/files/:/files \
-    -v $PWD/out/:/out \
-    simon987/sist2 scan -t 4 /files -o /out/my_idx1
-```
-**index**
-```bash
-docker run -it --network host\
-    -v $PWD/out/:/out \
-    simon987/sist2 index /out/my_idx1
-```
-
-**web**
-```bash
-docker run --rm --network host -d --name sist2\
-    -v $PWD/out/my_idx:/idx \
-    -v $PWD/my/files:/files
-    simon987/sist2 web --bind 0.0.0.0 /idx
-docker stop sist2
-```
+1. Scan a directory: `sist2 scan ~/Documents -o ./docs_idx`
+1. Push index to Elasticsearch: `sist2 index ./docs_idx`
+1. Start web interface: `sist2 web ./docs_idx`
 
 
 ## Format support
 
 File type | Library | Content | Thumbnail | Metadata
 :---|:---|:---|:---|:---
-pdf,xps,cbz,fb2,epub | MuPDF | yes | yes, `png` | title |
+pdf,xps,cbz,cbr,fb2,epub | MuPDF | text+ocr | yes, `png` | title |
 `audio/*` | ffmpeg | - | yes, `jpeg` | ID3 tags |
 `video/*` | ffmpeg | - | yes, `jpeg` | title, comment, artist |
-`image/*` | ffmpeg | - | yes, `jpeg` | `EXIF:Artist`, `EXIF:ImageDescription` |
+`image/*` | ffmpeg | - | yes, `jpeg` | [Common EXIF tags](https://github.com/simon987/sist2/blob/efdde2734eca9b14a54f84568863b7ffd59bdba3/src/parsing/media.c#L190) |
 ttf,ttc,cff,woff,fnt,otf | Freetype2 | - | yes, `bmp` | Name & style |
 `text/plain` | *(none)* | yes | no | - |
 tar, zip, rar, 7z, ar ...  | Libarchive | yes\* | - | no |
@@ -110,6 +93,21 @@ scan is also supported.
 
 To check if a media file can be parsed without *seek*, execute `cat file.mp4 | ffprobe -`
  
+ 
+### OCR
+
+You can enable OCR support for pdf,xps,cbz,cbr,fb2,epub file types with the
+`--ocr <lang>` option. Download the language data files with your
+package manager (`apt install tesseract-ocr-eng`) or directly [from Github](https://github.com/tesseract-ocr/tesseract/wiki/Data-Files).
+
+The `simon987/sist2` image comes with common languages 
+(hin, jpn, eng, fra, rus, spa) pre-installed.
+
+Examples
+```bash
+sist2 scan --ocr jpn ~/Books/Manga/
+sist2 scan --ocr eng ~/Books/Textbooks/
+```
 
 
 ## Build from source
@@ -121,15 +119,11 @@ binaries.
 
     *(Debian)*
     ```bash
-    apt install git cmake pkg-config libglib2.0-dev\
-        libssl-dev uuid-dev libavformat-dev libswscale-dev \
-        python3 libmagic-dev libfreetype6-dev libcurl-dev \
-        libbz2-dev yasm libharfbuzz-dev ragel libarchive-dev
-   ```
-    *(FreeBSD)*
-    ```bash
-   pkg install cmake gcc yasm gmake bash ffmpeg e2fsprogs-uuid\
-        autotools ragel libarchive
+    apt install git cmake pkg-config libglib2.0-dev \
+        libssl-dev uuid-dev python3 libmagic-dev libfreetype6-dev \
+        libcurl4-openssl-dev libbz2-dev yasm libharfbuzz-dev ragel \
+        libarchive-dev libtiff5 libpng16-16 libpango1.0-dev \
+        libxml2-dev libopenjp2-7-dev libleptonica-dev
    ```
 
 2. Build

USAGE.md

@@ -0,0 +1,275 @@
+# Usage
+
+*More examples (specifically with docker/compose) are in progress*
+
+* [scan](#scan)
+    * [options](#scan-options)
+    * [examples](#scan-examples)
+    * [index format](#index-format)
+* [index](#index)
+    * [options](#index-options)
+    * [examples](#index-examples)
+* [web](#web)
+    * [options](#web-options)
+    * [examples](#web-examples)
+    * [rewrite_url](#rewrite_url)
+    * [link to specific indices](#link-to-specific-indices)
+
+```
+Usage: sist2 scan [OPTION]... PATH
+   or: sist2 index [OPTION]... INDEX
+   or: sist2 web [OPTION]... INDEX...
+Lightning-fast file system indexer and search tool.
+
+    -h, --help            show this help message and exit
+    -v, --version         Show version and exit
+    --verbose             Turn on logging
+    --very-verbose        Turn on debug messages
+
+Scan options
+    -t, --threads=<int>   Number of threads. DEFAULT=1
+    -q, --quality=<flt>   Thumbnail quality, on a scale of 1.0 to 31.0, 1.0 being the best. DEFAULT=5
+    --size=<int>          Thumbnail size, in pixels. Use negative value to disable. DEFAULT=500
+    --content-size=<int>  Number of bytes to be extracted from text documents. Use negative value to disable. DEFAULT=32768
+    --incremental=<str>   Reuse an existing index and only scan modified files.
+    -o, --output=<str>    Output directory. DEFAULT=index.sist2/
+    --rewrite-url=<str>   Serve files from this url instead of from disk.
+    --name=<str>          Index display name. DEFAULT: (name of the directory)
+    --depth=<int>         Scan up to DEPTH subdirectories deep. Use 0 to only scan files in PATH. DEFAULT: -1
+    --archive=<str>       Archive file mode (skip|list|shallow|recurse). skip: Don't parse, list: only get file names as text, shallow: Don't parse archives inside archives. DEFAULT: recurse
+    --ocr=<str>           Tesseract language (use tesseract --list-langs to see which are installed on your machine)
+    -e, --exclude=<str>   Files that match this regex will not be scanned
+    --fast                Only index file names & mime type
+
+Index options
+    --es-url=<str>        Elasticsearch url with port. DEFAULT=http://localhost:9200
+    -p, --print           Just print JSON documents to stdout.
+    --script-file=<str>   Path to user script.
+    --batch-size=<int>    Index batch size. DEFAULT: 100
+    -f, --force-reset     Reset Elasticsearch mappings and settings. (You must use this option the first time you use the index command)
+
+Web options
+    --es-url=<str>        Elasticsearch url. DEFAULT=http://localhost:9200
+    --bind=<str>          Listen on this address. DEFAULT=localhost
+    --port=<str>          Listen on this port. DEFAULT=4090
+    --auth=<str>          Basic auth in user:password format
+Made by simon987 <me@simon987.net>. Released under GPL-3.0
+
+```
+
+## Scan
+
+### Scan options
+
+* `-t, --threads` 
+      Number of threads for file parsing. **Do not set a number higher than `$(nproc)`!**.
+* `-q, --quality` 
+    Thumbnail quality, on a scale of 1.0 to 31.0, 1.0 being the best. *Does not affect PDF thumbnails quality*
+* `--size` 
+    Thumbnail size in pixels.
+* `--content-size` 
+    Number of bytes of text to be extracted from the content of files (plain text and PDFs).
+    Repeated whitespace and special characters do not count toward this limit.
+* `--incremental`
+    Specify an existing index. Information about files in this index that were not modified (based on *mtime* attribute)
+    will be copied to the new index and will not be parsed again.
+* `-o, --output` Output directory. 
+* `--rewrite-url` Set the `rewrite_url` option for the web module (See [rewrite_url](#rewrite_url)) 
+* `--name` Set the `name` option for the web module
+* `--depth` Maximum scan dept. Set to 0 only scan files directly in the root directory, set to -1 for infinite depth
+* `--archive` Archive file mode.
+    * skip: Don't parse
+    * list: Only get file names as text
+    * shallow: Don't parse archives inside archives.
+    * recurse: Scan archives recursively (default)
+* `--ocr` See [OCR](README.md#OCR)
+* `-e, --exclude` Regex pattern to exclude files. A file is excluded if the pattern matches any 
+    part of the full absolute path.
+    
+    Examples: 
+    * `-e ".*\.ttf"`: Ignore ttf files
+    * `-e ".*\.(ttf|rar)"`: Ignore ttf and rar files
+    * `-e "^/mnt/backups/"`: Ignore all files in the `/mnt/backups/` directory
+    * `-e "^/mnt/Data[12]/"`: Ignore all files in the `/mnt/Data1/` and `/mnt/Data2/` directory
+    * `-e "(^/usr/)|(^/var/)|(^/media/DRIVE-A/tmp/)|(^/media/DRIVE-B/Trash/)"` Exclude the
+     `/usr`, `/var`, `/media/DRIVE-A/tmp`, `/media/DRIVE-B/Trash` directories
+* `--fast` Only index file names and mime type
+
+### Scan examples
+
+Simple scan
+```bash
+sist2 scan ~/Documents
+
+sist2 scan \
+    --threads 4 --content-size 16000000 --quality 1.0 --archive shallow \
+    --name "My Documents" --rewrite-url "http://nas.domain.local/My Documents/" \
+    ~/Documents -o ./documents.idx/
+```
+
+Incremental scan
+```
+sist2 scan --incremental ./orig_idx/ -o ./updated_idx/ ~/Documents
+```
+
+### Index format
+
+A typical `binary` type index structure looks like this:
+```
+documents.idx/
+├── descriptor.json
+├── _index_139965416830720
+├── _index_139965425223424
+├── _index_139965433616128
+├── _index_139965442008832
+└── thumbs
+    ├── data.mdb
+    └── lock.mdb
+```
+
+The `_index_*` files contain the raw binary index data and are not meant to be
+read by other applications. The format is generally compatible across different 
+sist2 versions.
+
+The `thumbs/` folder is a [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database)
+database containing the thumbnails.
+
+The `descriptor.json` file contains general information about the index. The 
+following fields are safe to modify manually: `root`, `name`, [rewrite_url](#rewrite_url) and `timestamp`.
+
+
+*Advanced usage*
+
+Instead of using the `scan` module, you can also import an index generated
+by a third party application. The 'external' index must have the following format:
+
+```
+my_index/
+├── descriptor.json
+├── _index_0
+└── thumbs
+    ├── data.mdb
+    └── lock.mdb
+```
+
+*descriptor.json*:
+```json
+{
+    "uuid": "<valid UUID4>",
+    "version": "_external_v1",
+    "root": "(optional)",
+    "name": "<name>",
+    "rewrite_url": "(optional)",
+    "type": "json",
+    "timestamp": 1578971024
+}
+```
+
+*_index_0*: NDJSON format (One json object per line)
+
+```json
+{
+  "_id": "unique uuid for the file",
+  "index": "index uuid4 (same one as descriptor.json!)",
+  "mime": "application/x-cbz",
+  "size": 14341204,
+  "mtime": 1578882996,
+  "extension": "cbz",
+  "name": "my_book",
+  "path": "path/to/books",
+  "content": "text contents of the book",
+  "title": "Title of the book",
+  "tag": ["genre.fiction", "author.someguy", "etc..."],
+  "_keyword": [
+    {"k": "ISBN", "v": "ABCD34789231"}
+  ],
+  "_text": [
+    {"k": "other", "v": "This will be indexed as text"}
+  ]
+}
+```
+
+You can find the full list of supported fields [here](src/io/serialize.c#L90)
+
+The `_keyword.*` items will be indexed and searchable as **keyword** fields (only full matches allowed).
+The `_text.*` items will be indexed and searchable as **text** fields (fuzzy searching allowed)
+
+
+*thumbs/*:
+
+LMDB key-value store. Keys are **binary** 128-bit UUID4s (`_id` field)
+and values are raw image bytes.
+
+Importing an external `binary` type index is technically possible but
+it is currently unsupported and has no guaranties of back/forward compatibility.
+
+
+## Index
+### Index options
+ * `--es-url` 
+ Elasticsearch url and port. If you are using docker, make sure that both containers are on the
+ same network.
+ * `-p, --print` 
+    Print index in JSON format to stdout.
+ * `--script-file` 
+    Path to user script. See [Scripting](scripting/README.md).
+ * `--batch-size=<int>` 
+    Index batch size. Indexing is generally faster with larger batches, but payloads that
+    are too large will fail and additional overhead for retrying with smaller sizes may slow
+    down the process.
+ * `-f, --force-reset` 
+    Reset Elasticsearch mappings and settings.
+    **(You must use this option the first time you use the index command)**.
+    
+### Index examples
+
+**Push to elasticsearch**
+```bash
+sist2 index --force-reset --batch-size 1000 --es-url http://localhost:9200 ./my_index/
+sist2 index ./my_index/
+```
+
+**Save index in JSON format**
+```bash
+sist2 index --print ./my_index/ > my_index.ndjson
+```
+
+**Inspect contents of an index**
+```bash
+sist2 index --print ./my_index/ | jq | less
+```
+
+## Web
+
+### Web options
+ * `--es-url=<str>` Elasticsearch url.
+ * `--bind=<str>` Listen on this address.
+ * `--port=<str>` Listen on this port.
+ * `--auth=<str>` Basic auth in user:password format
+ 
+### Web examples
+
+**Single index**
+```bash
+sist2 web --auth admin:hunter2 --bind 0.0.0.0 --port 8888 my_index
+```
+
+**Multiple indices**
+```bash
+# Indices will be displayed in this order in the web interface
+sist2 web index1 index2 index3 index4
+```
+
+### rewrite_url
+
+When the `rewrite_url` field is not empty, the web module ignores the `root`
+field and will return a HTTP redirect to `<rewrite_url><path>/<name><extension>`
+instead of serving the file from disk. 
+Both the `root` and `rewrite_url` fields are safe to manually modify from the 
+`descriptor.json` file.
+
+### Link to specific indices
+
+To link to specific indices, you can add a list of comma-separated index name to 
+the URL: `?i=<name>,<name>`. By default, indices with `"(nsfw)"` in their name are
+not displayed.

ci/build.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+./scripts/get_static_libs.sh
+
+cmake .
+make
+strip sist2

include/mce/config.h

@@ -1,53 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
- the documentation and/or other materials provided with the 
- distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
- may be used to endorse or promote products derived from this 
- software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-/**@file config/mce/config.h
- */
-#ifndef MCE_CONFIG_H
-#define MCE_CONFIG_H
-
-#include <libxml/xmlstring.h>
-#include <stdio.h>
-#include <plib/plib.h>
-#include <assert.h>
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define MCE_NAMESPACE_SUBSUMPTION_ENABLED 0
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif  
-
-#endif /* MCE_CONFIG_H */

include/mce/helper.h

@@ -1,189 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file mce/helper.h
-Helper functions needed by mce/textreader.h and mce/textwriter.h to implement MCE:
-- mceQNameLevelAdd(), mceQNameLevelLookup() and mceQNameLevelCleanup() maintain a set of mceQNameLevel_t tuples.
-- mceQNameLevelPush() and mceQNameLevelPopIfMatch() maintain a stack of mceQNameLevel_t tuples.
-- mceCtxInit(), mceCtxCleanup() and mceCtxUnderstandsNamespace() manage a context which holds all information needed to do MCE proprocessing.
- */
-#include <mce/config.h>
-
-#ifndef MCE_HELPER_H
-#define MCE_HELPER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-    /**
-      Tiple (ns, ln, level).
-    */
-    typedef struct MCE_QNAME_LEVEL {
-        xmlChar *ns;
-        xmlChar *ln;
-        puint32_t level;
-        puint32_t flag; // used by mceTextWriter
-    } mceQNameLevel_t;
-
-    /**
-     */
-    typedef enum MCE_SKIP_STATE_ENUM {
-        MCE_SKIP_STATE_IGNORE,
-        MCE_SKIP_STATE_ALTERNATE_CONTENT,
-        MCE_SKIP_STATE_CHOICE_MATCHED
-    } mceSkipState_t;
-
-    /**
-     Represents an intervall of levels which are "skipped" i.e. ignored.
-     */
-    typedef struct MCE_SKIP_ITEM {
-        puint32_t level_start;
-        puint32_t level_end;
-        mceSkipState_t state;
-    } mceSkipItem_t;
-
-    /**
-      Either represents a set of (ns, ln, level) triples.
-    */
-    typedef struct MCE_QNAME_LEVEL_SET {
-        mceQNameLevel_t *list_array;
-        puint32_t list_items;
-        puint32_t max_level;
-    } mceQNameLevelSet_t;
-
-    /**
-     The skip stack.
-     */
-    typedef struct MCE_SKIP_STACK {
-        mceSkipItem_t *stack_array;
-        puint32_t stack_items;
-    } mceSkipStack_t;
-
-
-    typedef enum MCE_ERROR_ENUM {
-        MCE_ERROR_NONE,
-        MCE_ERROR_XML,
-        MCE_ERROR_MUST_UNDERSTAND,
-        MCE_ERROR_VALIDATION,
-        MCE_ERROR_MEMORY
-    } mceError_t;
-
-    /**
-      Holds all information to do MCE preprocessing.
-    */
-    typedef struct MCE_CONTEXT {
-        mceQNameLevelSet_t ignorable_set;
-        mceQNameLevelSet_t understands_set;
-        mceQNameLevelSet_t processcontent_set;
-        mceQNameLevelSet_t suspended_set;
-#if (MCE_NAMESPACE_SUBSUMPTION_ENABLED)
-        mceQNameLevelSet_t subsume_namespace_set;
-        mceQNameLevelSet_t subsume_exclude_set;
-        mceQNameLevelSet_t subsume_prefix_set;
-#endif
-        mceSkipStack_t skip_stack;
-        mceError_t error;
-        pbool_t mce_disabled;        
-        puint32_t suspended_level;
-    } mceCtx_t;
-
-    /**
-      Add a new tiple (ns, ln, level) to the triple set \c qname_level_set.
-      The \c ns_sub string is optional and will not be touched.
-    */
-    pbool_t mceQNameLevelAdd(mceQNameLevelSet_t *qname_level_set, const xmlChar *ns, const xmlChar *ln, puint32_t level);
-
-    /**
-      Lookup a tiple (ns, ln, level) via \c ns and \c ln. If \c ignore_ln is PTRUE then the first tiple matching \c ns will be returned.
-    */
-    mceQNameLevel_t* mceQNameLevelLookup(mceQNameLevelSet_t *qname_level_set, const xmlChar *ns, const xmlChar *ln, pbool_t ignore_ln);
-
-    /**
-      Remove all triples (ns, ln, level) where the level greater or equal to \c level.
-    */
-    pbool_t mceQNameLevelCleanup(mceQNameLevelSet_t *qname_level_set, puint32_t level);
-
-    /**
-      Push a new skip intervall (level_start, level_end, state) on the stack \c skip_stack.
-    */
-    pbool_t mceSkipStackPush(mceSkipStack_t *skip_stack, puint32_t level_start, puint32_t level_end, mceSkipState_t state);
-
-    /**
-      Pop the intervall (ns, ln, level) from the stack \c qname_level_array.
-    */
-    void mceSkipStackPop(mceSkipStack_t *skip_stack);
-
-    /**
-     Returns top item or NULL.
-     */
-    mceSkipItem_t *mceSkipStackTop(mceSkipStack_t *skip_stack);
-
-    /**
-     Returns TRUE, if the \c level is in the top skip intervall.
-     */
-    pbool_t mceSkipStackSkip(mceSkipStack_t *skip_stack, puint32_t level);
-
-    /**
-      Initialize the mceCtx_t \c ctx.
-    */
-    pbool_t mceCtxInit(mceCtx_t *ctx);
-
-    /**
-      Cleanup, i.e. release all resourced from the mceCtx_t \c ctx.
-    */
-    pbool_t mceCtxCleanup(mceCtx_t *ctx);
-
-    /**
-      Register the namespace \ns in \c ctx.
-    */
-    pbool_t mceCtxUnderstandsNamespace(mceCtx_t *ctx, const xmlChar *ns);
-
-    /**
-     Register the namespace \ns in \c ctx.
-     */
-    pbool_t mceCtxSuspendProcessing(mceCtx_t *ctx, const xmlChar *ns, const xmlChar *ln);
-    
-
-
-#if (MCE_NAMESPACE_SUBSUMPTION_ENABLED)
-    /**
-    Subsume namespace \c ns_new with \c ns_old.
-     */
-    pbool_t mceCtxSubsumeNamespace(mceCtx_t *ctx, const xmlChar *prefix_new, const xmlChar *ns_new, const xmlChar *ns_old);
-#endif
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* MCE_HELPER_H */

include/mce/textreader.h

@@ -1,464 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file mce/textreader.h
- 
- */
-#ifndef MCE_TEXTREADER_H
-#define MCE_TEXTREADER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-    /**
-      A handle to an MCE-aware libxml2 xmlTextReader.
-    */
-    typedef struct MCE_TEXTREADER mceTextReader_t;
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-
-#include <mce/config.h>
-#include <opc/opc.h>
-#include <mce/helper.h>
-#include <libxml/xmlwriter.h>
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-    struct MCE_TEXTREADER {
-        xmlTextReaderPtr reader;
-        mceCtx_t mceCtx;
-    };
-
-    /**
-      Wrapper around an libxml2 xmlTextReaderRead function.
-      \see http://xmlsoft.org/html/libxml-xmlreader.html#xmlTextReaderRead
-    */
-    int mceTextReaderRead(mceTextReader_t *mceTextReader);
-
-    /**
-      Wrapper around a libxml2 xmlTextReaderNext function.
-      \see http://xmlsoft.org/html/libxml-xmlreader.html#xmlTextReaderNext
-    */
-    int mceTextReaderNext(mceTextReader_t *mceTextReader);
-
-    /** 
-      Creates an mceTextReader from an XmlTextReader. 
-      \code
-      mceTextReader reader;
-      mceTextReaderInit(&reader, xmlNewTextReaderFilename("sample.xml"));
-      // reader is ready to use.
-      mceTextReaderCleanup(&reader);
-      \endcode
-      \see http://xmlsoft.org/html/libxml-xmlreader.html#xmlNewTextReaderFilename
-    */
-    int mceTextReaderInit(mceTextReader_t *mceTextReader, xmlTextReaderPtr reader);
-
-    /**
-      Cleanup MCE reader, i.e. free all resources. Also calls xmlTextReaderClose and xmlFreeTextReader.
-      \see http://xmlsoft.org/html/libxml-xmlreader.html#xmlTextReaderClose
-      \see http://xmlsoft.org/html/libxml-xmlreader.html#xmlFreeTextReader
-    */
-    int mceTextReaderCleanup(mceTextReader_t *mceTextReader);
-
-    /** 
-      Reads all events \c mceTextReader and pipes them to \writer.
-      \code
-      mceTextReader reader;
-      mceTextReaderInit(&reader, xmlNewTextReaderFilename("sample.xml"));
-      mceTextReaderUnderstandsNamespace(&reader, _X("http://myextension"));
-      xmlTextWriterPtr writer=xmlNewTextWriterFilename("out.xml", 0);
-      mceTextReaderDump(&reader, writer, P_FALSE);
-      xmlFreeTextWriter(writer);
-      mceTextReaderCleanup(&reader);
-      \endcode
-      */
-    int mceTextReaderDump(mceTextReader_t *mceTextReader, xmlTextWriter *writer, pbool_t fragment);
-
-    /**
-      Registers an MCE namespace.
-      \see mceTextReaderDump()
-      */
-    int mceTextReaderUnderstandsNamespace(mceTextReader_t *mceTextReader, const xmlChar *ns);
-
-    /**
-     Disable MCE processing.
-     \return Returns old value.
-     */
-    pbool_t mceTextReaderDisableMCE(mceTextReader_t *mceTextReader, pbool_t flag);
-
-
-    /**
-     Signal an error to the MCE processor.
-     */
-    void mceRaiseError(xmlTextReader *reader, mceCtx_t *ctx, mceError_t error, const xmlChar *str, ...);
-
-    /**
-        Internal function which does the MCE postprocessing. E.g. mceTextReaderRead() is implemented as
-        \code
-        mceTextReaderPostprocess(mceTextReader->reader, &mceTextReader->mceCtx, xmlTextReaderRead(mceTextReader->reader))
-        \endcode
-        This function is exposed to make existing libxm2 xmlTextReader MCE aware.
-    */
-    int mceTextReaderPostprocess(xmlTextReader *reader, mceCtx_t *ctx, int ret);
-
-    /**
-     Get the error code.
-     */
-    mceError_t mceTextReaderGetError(mceTextReader_t *mceTextReader);
-
-/**
- Helper macro to declare a start/end document block in a declarative way:
- \code
-  mce_start_document(reader) {
-  } mce_end_document(reader);
-  \endcode
-  \hideinitializer
-*/
-#define mce_start_document(_reader_) \
-    if (NULL!=(_reader_)) {            \
-        mceTextReaderRead(_reader_); \
-        if (0)                     
-
-/**
-  \see mce_start_document.
-  \hideinitializer
-*/
-#define mce_end_document(_reader_)   \
-    } /* if (NULL!=reader) */        \
-
-
-/**
-  Container for mce_start_element and mce_start_attribute declarations.
-  \see mce_match_element
-  \see mce_match_attribute
-  \hideinitializer
-  */
-#define mce_start_choice(_reader_)  \
-    if (0)                          
-
-/**
-  \see mce_start_choice
-  \hideinitializer
-  */
-#define mce_end_choice(_reader_) 
-
-
-/**
-  Skips the attributes. 
-  \see mce_match_element.
-  \hideinitializer
-*/
-#define mce_skip_attributes(_reader_) \
-    mce_start_attributes(_reader_) {  \
-    } mce_end_attributes(_reader_);   
-
-
-/**
-  Skips the attributes. 
-  \see mce_match_attribute.
-  \hideinitializer
-*/
-#define mce_skip_children(_reader_) \
-    mce_start_children(_reader_) {  \
-    } mce_end_children(_reader_);   
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_start_children(_reader_)                  \
-if (!xmlTextReaderIsEmptyElement((_reader_)->reader)) { \
-    mceTextReaderRead(_reader_); do {                 \
-        if (0)                                        
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_end_children(_reader_)                                                      \
-        else {                                                                          \
-            if (XML_READER_TYPE_END_ELEMENT!=xmlTextReaderNodeType((_reader_)->reader)) { \
-                mceTextReaderNext(_reader_); /*skip unhandled element */                \
-            }                                                                           \
-        }                                                                               \
-    } while(XML_READER_TYPE_END_ELEMENT!=xmlTextReaderNodeType((_reader_)->reader) &&     \
-            XML_READER_TYPE_NONE!=xmlTextReaderNodeType((_reader_)->reader));             \
-} /* if (!xmlTextReaderIsEmptyElement(reader->reader)) */                               
-
-
-/**
-  Helper macro to match an element. Usefull for calling code in a seperate function:
-
-  \code
-  void handleElement(reader) {
-    mce_start_choice(reader) {
-        mce_start_element(reader, _X("ns"), _X("element")) {
-            
-        } mce_end_element(reader)
-    } mce_end_choice(reader);
-  }
-
-  void parse(reader) {
-    mce_start_document(reader) {
-      mce_start_element(reader, _X("ns"), _X("ln")) {
-        mce_skip_attributes(reader);
-        mce_start_children(reader) {
-           mce_match_element(reader, _X("ns"), _X("element")) {
-             handleElement(reader);
-           }
-        } mce_end_children(reader);
-      } mce_end_element();
-    } mce_end_document(reader);
-  }
-  \endcode
-  \hideinitializer
-*/
-#define mce_match_element(_reader_, ns, ln)                                                       \
-    } else if (XML_READER_TYPE_ELEMENT==xmlTextReaderNodeType((_reader_)->reader)                 \
-            && (NULL==ns || 0==xmlStrcmp(ns, xmlTextReaderConstNamespaceUri((_reader_)->reader))) \
-            && (NULL==ln || 0==xmlStrcmp(ln, xmlTextReaderConstLocalName((_reader_)->reader)))) { 
-
-
-/**
- Helper macro to declare a element block in a declarative way:
- \code
-  mce_start_element(reader) {
-    mce_start_attributes(reader) {
-      mce_start_attribute(reader, _X("ns"), _X("lnA")) {
-         // code for handling lnA.
-      } mce_end_attribute(reader);
-      mce_start_attribute(reader, _X("ns"), _X("lnB")) {
-         // code for handling lnB.
-      } mce_end_attribute(reader);
-    } mce_end_attributes(reader);
-    mce_start_children(reader) {
-        mce_start_element(reader, _X("ns"), _X("lnA")) {
-         // code for handling lnA.
-        } mce_end_element(reader);
-        mce_start_element(reader, _X("ns"), _X("lnB")) {
-         // code for handling lnB.
-        } mce_end_element(reader);
-        mce_start_text(reader) {
-         // code for handling text.
-        } mce_end_text(reader);
-    } mce_end_children(reader);
-  } mce_end_element(reader);
-  \endcode
-  \hideinitializer
-*/
-#define mce_start_element(_reader_, ns, ln) \
-    mce_match_element(_reader_, ns, ln)     
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_end_element(_reader_) \
-    mceTextReaderNext(_reader_)   
-
-/**
-  Matches #TEXT without consuming it.
-  \hideinitializer
-*/
-#define mce_match_text(_reader_)                                                                   \
-    } else if (XML_READER_TYPE_TEXT==xmlTextReaderNodeType((_reader_)->reader)                     \
-            || XML_READER_TYPE_SIGNIFICANT_WHITESPACE==xmlTextReaderNodeType((_reader_)->reader)) {
-
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_start_text(_reader_) \
-    mce_match_text(_reader_)      
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_end_text(_reader_) \
-    mceTextReaderNext(_reader_)
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_start_attributes(_reader_)                            \
-    if (1==xmlTextReaderMoveToFirstAttribute((_reader_)->reader)) { \
-        do {                                                      \
-            if (0)                                                
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_end_attributes(_reader_)                                    \
-            else { /* skipped attribute */ }                            \
-        } while(1==xmlTextReaderMoveToNextAttribute((_reader_)->reader)); \
-    xmlTextReaderMoveToElement((_reader_)->reader); }                     
-
-/**
-  Helper macro to match an attribute. Usefull for calling code in a seperate function:
-
-  \code
-  void handleA(reader) {
-    mce_start_choice(reader) {
-        mce_start_attribute(reader, _X("ns"), _X("attr")) {
-
-        } mce_end_attribute(reader);
-    } mce_end_choice(reader);
-  }
-
-  void parse(reader) {
-    mce_start_document(reader) {
-      mce_start_element(reader, _X("ns"), _X("ln")) {
-        mce_start_attributes(reader) {
-           mce_match_attribute(reader, _X("ns"), _X("attr")) {
-             handleA(reader);
-           }
-        } mce_end_attributes(reader);
-        mce_skip_children(reader);
-      } mce_end_element();
-    } mce_end_document(reader);
-  }
-  \endcode
-  \hideinitializer
-*/
-#define mce_match_attribute(_reader_, ns, ln)                                                   \
-    } else if ((NULL==ns || 0==xmlStrcmp(ns, xmlTextReaderConstNamespaceUri((_reader_)->reader))) \
-            && (NULL==ln || 0==xmlStrcmp(ln, xmlTextReaderConstLocalName((_reader_)->reader)))) { 
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_start_attribute(_reader_, ns, ln) \
-    mce_match_attribute(_reader_, ns, ln) 
-
-/**
-  \see mce_start_element.
-  \hideinitializer
-*/
-#define mce_end_attribute(_reader_)
-
-
-/**
-  Error handling for MCE parsers.
-  \code
-   mce_start_element(&reader, NULL, _X("Default")) {
-       const xmlChar *ext=NULL;
-       const xmlChar *type=NULL;
-       mce_start_attributes(&reader) {
-           mce_start_attribute(&reader, NULL, _X("Extension")) {
-               ext=xmlTextReaderConstValue(reader.reader);
-           } mce_end_attribute(&reader);
-           mce_start_attribute(&reader, NULL, _X("ContentType")) {
-               type=xmlTextReaderConstValue(reader.reader);
-           } mce_end_attribute(&reader);
-       } mce_end_attributes(&reader);
-       mce_error_guard_start(&reader) {
-           mce_error(&reader, NULL==ext || ext[0]==0, MCE_ERROR_VALIDATION, "Missing @Extension attribute!");
-           mce_error(&reader, NULL==type || type[0]==0, MCE_ERROR_VALIDATION, "Missing @ContentType attribute!");
-           opcContainerType *ct=insertType(c, type, OPC_TRUE);
-           mce_error(&reader, NULL==ct, MCE_ERROR_MEMORY, NULL);
-           opcContainerExtension *ce=opcContainerInsertExtension(c, ext, OPC_TRUE);
-           mce_error(&reader, NULL==ce, MCE_ERROR_MEMORY, NULL);
-           mce_errorf(&reader, NULL!=ce->type && 0!=xmlStrcmp(ce->type, type), MCE_ERROR_VALIDATION, "Extension \"%s\" is mapped to type \"%s\" as well as \"%s\"", ext, type, ce->type);
-           ce->type=ct->type;
-       } mce_error_guard_end(&reader);
-       mce_skip_children(&reader);
-   } mce_end_element(&reader);
-  \endcode
-  \hideinitializer
-*/
-#define mce_error_guard_start(_reader_) if (MCE_ERROR_NONE==(_reader_)->mceCtx.error) do {
-
-/**
-  \see mce_error_guard_start
-  \hideinitializer
-*/
-#define mce_error_guard_end(_reader_)  } while(0)
-
-/**
-  Signal an error if guard if false.
-  \hideinitializer
-*/
-#define mce_error(_reader_, guard, err, msg) if (guard) { (_reader_)->mceCtx.error=(err); fprintf(stderr, (NULL!=msg?msg:#err));  continue; }
-
-/**
-  Signal an error if guard if false.
-  \hideinitializer
-*/
-#if defined(__GNUC__)
-#define mce_errorf(_reader_, guard, err, msg, ...) if (guard) { mceRaiseError((_reader_)->reader, &(_reader_)->mceCtx, err, _X((NULL!=msg?msg:#err)), ##__VA_ARGS__ );  continue; }
-#else
-#define mce_errorf(_reader_, guard, err, msg, ...) if (guard) { mceRaiseError((_reader_)->reader, &(_reader_)->mceCtx, err, _X((NULL!=msg?msg:#err)), __VA_ARGS__ );  continue; }
-#endif
-
-/**
-  Only issues the error when in "strict mode".
-  \hideinitializer
-*/
-#define mce_error_strict mce_error
-
-/**
-  \see mce_error_strict
-  \hideinitializer
-*/
-#define mce_error_strictf mce_errorf
-
-
-/**
-  Marker for a MCE defintion.
-  \hideinitializer
-*/
-#define mce_def
-
-/**
-  Marker for a MCE reference.
-  \hideinitializer
-*/
-#define mce_ref(r) (r)
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* MCE_TEXTREADER_H */

include/mce/textwriter.h

@@ -1,176 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file mce/textwriter.h
-
-*/
-#include <mce/config.h>
-#include <libxml/xmlwriter.h>
-#include <mce/helper.h>
-
-#ifndef MCE_TEXTWRITER_H
-#define MCE_TEXTWRITER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-/**
-  Default flags for an MCE namespace declaration.
-  */
-#define MCE_DEFAULT 0x0
-
-/**
-  Flags MCE namespace declaration "ignorable".
-  */
-#define MCE_IGNORABLE 0x1
-
-/**
-  Flags MCE namespace declaration "must understand".
-  */
-#define MCE_MUSTUNDERSTAND 0x2
-
-    /**
-      The MCE text writer context.
-      */
-    typedef struct MCE_TEXTWRITER_STRUCT mceTextWriter;
-
-    /**
-      Create a new MCE text writer.
-      \see http://xmlsoft.org/html/libxml-xmlIO.html#xmlOutputBufferCreateIO
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlNewTextWriter
-      */
-    mceTextWriter *mceTextWriterCreateIO(xmlOutputWriteCallback iowrite, xmlOutputCloseCallback  ioclose, void *ioctx, xmlCharEncodingHandlerPtr encoder);
-
-    /**
-      Helper which create a new MCE text writer for a FILE handle.
-      */
-    mceTextWriter *mceNewTextWriterFile(FILE *file);
-
-    /**
-      Free all resources for \w.
-      */
-    int mceTextWriterFree(mceTextWriter *w);
-
-    /**
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartDocument
-      */
-    int mceTextWriterStartDocument(mceTextWriter *w);
-
-    /**
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterEndDocument
-      */
-    int mceTextWriterEndDocument(mceTextWriter *w);
-
-    /**
-      Start a new XML element. If ns==NULL then there is no namespace and ""==ns means the default namespace.
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartElement
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartElementNS
-      */
-    int mceTextWriterStartElement(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln);
-
-    /**
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterEndElement
-      */
-    int mceTextWriterEndElement(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln);
-
-    /**
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterWriteString
-      */
-    int mceTextWriterWriteString(mceTextWriter *w, const xmlChar *content);
-
-    /**
-      Register a namespace. Must be called before mceTextWriterStartElement.
-      \see MCE_DEFAULT
-      \see MCE_IGNORABLE
-      \see MCE_MUSTUNDERSTAND
-      */
-    const xmlChar *mceTextWriterRegisterNamespace(mceTextWriter *w, const xmlChar *ns, const xmlChar *prefix, int flags);
-
-    /**
-      Register qname (ns, ln) as a "process content" element wrt. MCE. Must be called before mceTextWriterStartElement.
-      */
-    int mceTextWriterProcessContent(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln);
-
-    /**
-      Writes a formatted attribute.
-      \see http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterWriteFormatAttribute
-      */
-    int mceTextWriterAttributeF(mceTextWriter *w, const xmlChar *ns, const xmlChar *ln, const char *value, ...);
-
-    /**
-      Starts an MCE alternate content section.
-      */
-    int mceTextWriterStartAlternateContent(mceTextWriter *w);
-
-    /**
-      Ends an MCE alternate content section.
-      */
-    int mceTextWriterEndAlternateContent(mceTextWriter *w);
-
-    /**
-      Start an MCE choice.
-      */
-    int mceTextWriterStartChoice(mceTextWriter *w, const xmlChar *ns);
-
-    /**
-      Ends an MCE choice.
-      */
-    int mceTextWriterEndChoice(mceTextWriter *w);
-
-    /**
-      Start an MCE fallback.
-      */
-    int mceTextWriterStartFallback(mceTextWriter *w);
-
-    /**
-      Ends an MCE fallback.
-      */
-    int mceTextWriterEndFallback(mceTextWriter *w);
-
-
-    /**
-      Returns the underlying xmlTextWriter.
-      */
-    xmlTextWriterPtr mceTextWriterIntern(mceTextWriter *w);
-
-    /**
-      Helper which create a new xmlTextWriterPtr for a FILE handle.
-      */
-    xmlTextWriterPtr xmlNewTextWriterFile(FILE *file);
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-
-#endif /* MCE_TEXTWRITER_H */

include/opc/config.h

@@ -1,189 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
- the documentation and/or other materials provided with the 
- distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
- may be used to endorse or promote products derived from this 
- software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-/**@file config/opc/config.h
- */
-#ifndef OPC_CONFIG_H
-#define OPC_CONFIG_H
-
-#include <libxml/xmlstring.h>
-#include <plib/plib.h>
-#include <assert.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif   
-
-
-/**
-  Assert expression e is true. Will be removed entirely in release mode.
-  \hideinitializer
- */
-#define OPC_ASSERT(e) assert(e)
-
-/**
-  Assert expression e is true. Expression will be executed in release mode too.
-  \hideinitializer
- */
-#ifdef NDEBUG
-#define OPC_ENSURE(e) (void)(e)
-#else
-#define OPC_ENSURE(e) assert(e)
-#endif
-
-
-/**
-  Constant for boolean true.
-  \hideinitializer
- */
-#define OPC_TRUE (0==0)
-
-/**
-  Constant for boolean false.
-  \hideinitializer
- */
-#define OPC_FALSE (0==1)
-
-    /** 
-      Boolean type.
-      \hideinitializer
-      */
-    typedef pbool_t opc_bool_t;
-
-    /** 
-      Type which represents an offset in e.g. a file.
-      \hideinitializer
-      */
-    typedef pofs_t opc_ofs_t;
-
-    /** 
-      8-bit unsigned integer.
-      \hideinitializer
-      */
-    typedef puint8_t opc_uint8_t;
-
-    /** 
-      16-bit unsigned integer.
-      \hideinitializer
-      */
-    typedef puint16_t opc_uint16_t;
-
-    /** 
-      32-bit unsigned integer.
-      \hideinitializer
-      */
-    typedef puint32_t opc_uint32_t;
-
-    /** 
-      64-bit unsigned integer.
-      \hideinitializer
-      */
-    typedef puint64_t opc_uint64_t;
-
-    /** 
-      8-bit signed integer.
-      \hideinitializer
-      */
-    typedef pint8_t opc_int8_t;
-
-    /** 
-      16-bit signed integer.
-      \hideinitializer
-      */
-    typedef pint16_t opc_int16_t;
-
-    /** 
-      32-bit signed integer.
-      \hideinitializer
-      */
-    typedef pint32_t opc_int32_t;
-
-    /** 
-      64-bit signed integer.
-      \hideinitializer
-      */
-    typedef pint64_t opc_int64_t;
-
-/**
-  Default size fo the deflate buffer used by zlib.
-  */
-#define OPC_DEFLATE_BUFFER_SIZE 4096
-
-/**
-  Max system path len.
-  */
-#define OPC_MAX_PATH 512
-
-    /**
-      Error codes for the OPC module.
-      */
-    typedef enum OPC_ERROR_ENUM {
-        OPC_ERROR_NONE,
-        OPC_ERROR_STREAM,
-        OPC_ERROR_SEEK, // can't seek
-        OPC_ERROR_UNSUPPORTED_DATA_DESCRIPTOR,
-        OPC_ERROR_UNSUPPORTED_COMPRESSION,
-        OPC_ERROR_DEFLATE,
-        OPC_ERROR_HEADER,
-        OPC_ERROR_MEMORY,
-        OPC_ERROR_XML, 
-        OPC_ERROR_USER // user triggered an abort
-    } opc_error_t;
-    
-    /**
-      Compression options for OPC streams.
-      */
-    typedef enum OPC_COMPRESSIONOPTION_ENUM {
-        OPC_COMPRESSIONOPTION_NONE,
-        OPC_COMPRESSIONOPTION_NORMAL,
-        OPC_COMPRESSIONOPTION_MAXIMUM,
-        OPC_COMPRESSIONOPTION_FAST,
-        OPC_COMPRESSIONOPTION_SUPERFAST
-    } opcCompressionOption_t;
-
-
-/**
-  Helper for debug logs.
-  \hideinitializer
-  */
-#define opc_logf printf
-
-/**
-  Abstraction for memset(m, 0, s).
-  \hideinitializer
- */
-#define opc_bzero_mem(m,s) memset(m, 0, s)
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif  
-
-#endif /* OPC_CONFIG_H */

include/opc/container.h

@@ -1,300 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/container.h
-
- The container.h module has the fundamental methods for dealing with ZIP-based OPC container. 
- 
- OPC container can be opened in READ-ONLY mode, WRITE-ONLY mode, READ/WRITE mode, TEMPLATE mode and TRANSITION mode. 
- The most notable mode is the READ/WRITE mode, which gives you concurrent stream-based READ and WRITE access to a 
- single ZIP-based OPC container. This is achieved without the use of temporary files by taking advantage of the 
- OPC specific “interleave” mode. \see http://standards.iso.org/ittf/PubliclyAvailableStandards/c051459_ISOIEC_29500-2_2008(E).zip
- 
- The TEMPLATE mode allows very fast customized "cloning" of ZIP-based OPC container by using "RAW access" to the ZIP streams. 
- The TRANSITION mode is a special version of the TEMPLATE mode, which allows transition-based READ/WRITE access to the 
- ZIP-based OPC container using a temporary file.
- 
- */
-#include <opc/config.h>
-#include <opc/file.h>
-
-#ifndef OPC_CONTAINER_H
-#define OPC_CONTAINER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-    /**
-     Handle to an OPC container created by \ref opcContainerOpen.
-     \see opcContainerOpen.
-     */
-    typedef struct OPC_CONTAINER_STRUCT opcContainer;
-    
-    /**
-     Modes for opcContainerOpen();
-     \see opcContainerOpen
-     */
-    typedef enum {
-        /**
-         Opens the OPC container denoted by \a fileName in READ-ONLY mode. The \a destName parameter must be \a NULL.
-         \hideinitializer
-         */
-        OPC_OPEN_READ_ONLY=0, 
-        /**
-         Opens the OPC container denoted by \a fileName in WRITE-ONLY mode. The \a destName parameter must be \a NULL.
-         \hideinitializer
-         */
-        OPC_OPEN_WRITE_ONLY=1,
-        /**
-         Opens the OPC container denoted by \a fileName in READ/WRITE mode. The \a destName parameter must be \a NULL.
-         \hideinitializer
-         */
-        OPC_OPEN_READ_WRITE=2,
-        /**
-         This mode will open the container denoted by \a fileName in READ-ONLY mode and the container denoted by 
-         \a destName in write-only mode. Any modifications will be written to the container denoted by \a destName 
-         and the unmodified streams from \a fileName will be written to \a destName on closing.
-         \warning Currently not implemented.
-         \hideinitializer
-         */
-        OPC_OPEN_TEMPLATE=3,
-        /**
-         Like the OPC_OPEN_TEMPLATE mode, but the \a destName will be renamed to the \a fileName on closing. If \a destName 
-         is \a NULL, then the name of the temporary file will be generated automatically.
-         \warning Currently not implemented.
-         \hideinitializer
-         */
-        OPC_OPEN_TRANSITION=4
-    } opcContainerOpenMode; 
-    
-    /** Modes for opcContainerClose.
-     \see opcContainerClose.
-     */
-    typedef enum {
-        /**
-         Close the OPC container without any further postprocessing.
-         \hideinitializer
-         */
-        OPC_CLOSE_NOW = 0,
-        /**
-         Close the OPC container and trim the file by removing unused fragments like e.g. 
-         deleted parts.
-         \hideinitializer
-         */
-        OPC_CLOSE_TRIM = 1,
-        /**
-         Close the OPC container like in \a OPC_CLOSE_TRIM mode, but additionally remove any 
-         "interleaved" parts by reordering them.
-         \warning Currently not implemented. Same semantic as OPC_CLOSE_TRIM.       
-         \hideinitializer
-         */
-        OPC_CLOSE_DEFRAG = 2
-    } opcContainerCloseMode;
-    
-    /**
-     Opens a ZIP-based OPC container.
-     @param[in] fileName. For more details see \ref opcContainerOpenMode.
-     @param[in] mode. For more details see \ref opcContainerOpenMode.
-     @param[in] userContext. Will not be modified by libopc. Can be used to e.g. store the "this" pointer for C++ bindings.
-     @param[in] destName. For more details see \ref opcContainerOpenMode.
-     @return \a NULL if failed. 
-     \see opcContainerOpenMode
-     \see opcContainerDump
-     */
-    opcContainer* opcContainerOpen(const xmlChar *fileName, 
-                                   opcContainerOpenMode mode, 
-                                   void *userContext, 
-                                   const xmlChar *destName);
-
-    /**
-     Opens a ZIP-based OPC container from memory.
-     @param[in] data. 
-     @param[in] data_len.
-     @param[in] userContext. Will not be modified by libopc. Can be used to e.g. store the "this" pointer for C++ bindings.
-     @param[in] mode. For more details see \ref opcContainerOpenMode.
-     @return \a NULL if failed. 
-     */
-    opcContainer* opcContainerOpenMem(const opc_uint8_t *data, opc_uint32_t data_len,
-                                      opcContainerOpenMode mode, 
-                                      void *userContext);
-
-    /**
-     Opens a ZIP-based OPC container from memory.
-     @param[in] ioread. 
-     @param[in] iowrite. 
-     @param[in] ioclose. 
-     @param[in] ioseek. 
-     @param[in] iotrim. 
-     @param[in] ioflush. 
-     @param[in] iocontext. 
-     @param[in] file_size. 
-     @param[in] userContext. Will not be modified by libopc. Can be used to e.g. store the "this" pointer for C++ bindings.
-     @param[in] mode. For more details see \ref opcContainerOpenMode.
-     @return \a NULL if failed. 
-     */
-    opcContainer* opcContainerOpenIO(opcFileReadCallback *ioread,
-                                     opcFileWriteCallback *iowrite,
-                                     opcFileCloseCallback *ioclose,
-                                     opcFileSeekCallback *ioseek,
-                                     opcFileTrimCallback *iotrim,
-                                     opcFileFlushCallback *ioflush,
-                                     void *iocontext,
-                                     pofs_t file_size,
-                                     opcContainerOpenMode mode, 
-                                     void *userContext);
-    
-    /**
-     Close an OPC container.
-     @param[in] c. \ref opcContainer openered by \ref opcContainerOpen.
-     @param[in] mode. For more information see \ref opcContainerCloseMode.
-     @return Non-zero if successful.
-     \see opcContainerOpen
-     \see opcContainerCloseMode
-     */
-    opc_error_t opcContainerClose(opcContainer *c, opcContainerCloseMode mode);
-    
-    /**
-     Returns the unmodified user context passed to \ref opcContainerOpen.
-     \see opcContainerOpen
-     */
-    void *opcContainerGetUserContext(opcContainer *c);
-    
-    /**
-     List all types, relations and parts of the container \a c to \a out.
-     \par Sample:
-     \include opc_dump.c
-     */
-    opc_error_t opcContainerDump(opcContainer *c, FILE *out);
-    
-    /**
-     Exports the OPC container to "Flat OPC" (http://blogs.msdn.com/b/ericwhite/archive/2008/09/29/the-flat-opc-format.aspx).
-     The flat versions of an OPC file are very important when dealing with e.g XSL(T)-based or Javascript-based transformations.
-     \see opcContainerFlatImport.
-     \todo Implementation needed.
-     */
-    int opcContainerFlatExport(opcContainer *c, const xmlChar *fileName);
-    
-    /**
-     Imports the flat version of an OPC container. 
-     \see opcContainerFlatExport.
-     \todo Implementation needed.
-     */
-    int opcContainerFlatImport(opcContainer *c, const xmlChar *fileName);
-    
-    /**
-     Iterate all types.
-     \code
-     for(xmlChar *type=opcContentTypeFirst(c);
-         NULL!=type;
-         type=opcContentTypeNext(c, type)) {
-        printf("%s\n", type);
-     }
-     \endcode
-    */
-    const xmlChar *opcContentTypeFirst(opcContainer *container);
-    
-    /**
-     \see opcContentTypeNext()
-    */
-    const xmlChar *opcContentTypeNext(opcContainer *container, const xmlChar *type);
-
-    /**
-     Iterate extensions.
-     \code
-     for(const xmlChar *ext=opcExtensionFirst(c);
-         NULL!=ext;
-         ext=opcExtensionNext(ext)) {
-        printf("%s\n", ext);
-     }
-     \endcode
-    */
-    const xmlChar *opcExtensionFirst(opcContainer *container);
-    
-    /**
-     \see opcExtensionFirst()
-     */
-    const xmlChar *opcExtensionNext(opcContainer *container, const xmlChar *ext);
-    
-    /**
-     Get registered type for extension.
-     \see opcExtensionRegister()
-     */
-    const xmlChar *opcExtensionGetType(opcContainer *container, const xmlChar *ext);
-
-    /**
-     Register a mime-type and and extension.
-     \see opcExtensionGetType()
-     */
-    const xmlChar *opcExtensionRegister(opcContainer *container, const xmlChar *ext, const xmlChar *type);
-
-
-    /**
-     Iterator through all relation types of the container:
-     \code
-     for(xmlChar *type=opcRelationTypeFirst(c);
-         NULL!=type;
-         type=opcRelationTypeNext(c, type)) {
-        printf("%s\n", type);
-     }
-     \endcode
-     */
-    const xmlChar *opcRelationTypeFirst(opcContainer *container);
-
-    /**
-     \see opcRelationTypeFirst()
-    */
-    const xmlChar *opcRelationTypeNext(opcContainer *container, const xmlChar *type);
-
-
-    /**
-     Iterator through all relation types of the container:
-     \code
-     for(xmlChar *target=opcExternalTargetFirst(c);
-         NULL!=target;
-         type=opcExternalTargetNext(c, target)) {
-        printf("%s\n", target);
-     }
-     \endcode
-     */
-    const xmlChar *opcExternalTargetFirst(opcContainer *container);
-
-    /**
-     \see opcExternalTargetFirst()
-    */
-    const xmlChar *opcExternalTargetNext(opcContainer *container, const xmlChar *target);
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_CONTAINER_H */

include/opc/file.h

@@ -1,200 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/file.h
- The opc module contains the file library functions.
-*/
-#include <opc/config.h>
-
-#ifndef OPC_FILE_H
-#define OPC_FILE_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-/**
-  Flag for READ access.
-  \hideinitializer
-*/
-#define OPC_FILE_READ  (1<<0)
-
-/**
-  Flag for WRITE access.
-  \hideinitializer
-*/
-#define OPC_FILE_WRITE (1<<1)
-
-/**
-  Flag indicates that file will be truncated when opened.
-  \hideinitializer
-*/
-#define OPC_FILE_TRUNC  (1<<2)
-
-
-    /** 
-      Abstraction for see modes.
-      */
-    typedef enum OPC_FILESEEKMODE_ENUM {
-        opcFileSeekSet = SEEK_SET,
-        opcFileSeekCur = SEEK_CUR,
-        opcFileSeekEnd = SEEK_END
-    } opcFileSeekMode;
-
-     /**
-      Callback to read a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static int opcFileRead(void *iocontext, char *buffer, int len) {
-          return fread(buffer, sizeof(char), len, (FILE*)iocontext);
-      }
-      \endcode
-      */
-    typedef int opcFileReadCallback(void *iocontext, char *buffer, int len);
-
-     /**
-      Callback to write a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static int opcFileWrite(void *iocontext, const char *buffer, int len) {
-          return fwrite(buffer, sizeof(char), len, (FILE*)iocontext);
-      }
-      \endcode
-      */
-    typedef int opcFileWriteCallback(void *iocontext, const char *buffer, int len);
-
-     /**
-      Callback to close a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static int opcFileClose(void *iocontext) {
-          return fclose((FILE*)iocontext);
-      }
-      \endcode
-      */
-    typedef int opcFileCloseCallback(void *iocontext);
-
-     /**
-      Callback to seek a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static opc_ofs_t opcFileSeek(void *iocontext, opc_ofs_t ofs) {
-          int ret=fseek((FILE*)iocontext, ofs, SEEK_SET);
-          if (ret>=0) {
-              return ftell((FILE*)iocontext);
-          } else {
-              return ret;
-          }
-      }
-      \endcode
-      */
-    typedef opc_ofs_t opcFileSeekCallback(void *iocontext, opc_ofs_t ofs);
-
-     /**
-      Callback to trim a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static int opcFileTrim(void *iocontext, opc_ofs_t new_size) {
-      #ifdef WIN32
-          return _chsize(fileno((FILE*)iocontext), new_size);
-      #else
-          return ftruncate(fileno((FILE*)iocontext), new_size);
-      #endif
-      }
-      \endcode
-      */
-    typedef int opcFileTrimCallback(void *iocontext, opc_ofs_t new_size);
-
-     /**
-      Callback to flush a file. E.g. for a FILE * context this can be implemented as
-      \code
-      static int opcFileFlush(void *iocontext) {
-          return fflush((FILE*)iocontext);
-      }
-      \endcode
-      */
-    typedef int opcFileFlushCallback(void *iocontext);
-
-    /**
-      Represents a state of a file, i.e. file position (buf_pos) and error status (err).
-      */
-    typedef struct OPC_FILERAWSTATE_STRUCT {
-        opc_error_t err;
-        opc_ofs_t   buf_pos; // current pos in file
-    } opcFileRawState;
-
-    /**
-     File IO context.
-     */
-    typedef struct OPC_IO_STRUCT {
-        opcFileReadCallback *_ioread;
-        opcFileWriteCallback *_iowrite;
-        opcFileCloseCallback *_ioclose;
-        opcFileSeekCallback *_ioseek;
-        opcFileTrimCallback *_iotrim;
-        opcFileFlushCallback *_ioflush;
-        void *iocontext;
-        int flags;
-        opcFileRawState state;
-        opc_ofs_t file_size;
-    } opcIO_t;
-
-    /**
-      Initialize an IO context.
-      */
-    opc_error_t opcFileInitIO(opcIO_t *io,
-                              opcFileReadCallback *ioread,
-                              opcFileWriteCallback *iowrite,
-                              opcFileCloseCallback *ioclose,
-                              opcFileSeekCallback *ioseek,
-                              opcFileTrimCallback *iotrim,
-                              opcFileFlushCallback *ioflush,
-                              void *iocontext,
-                              pofs_t file_size,
-                              int flags);
-
-    /**
-      Initialize an IO context for a file.
-      */
-    opc_error_t opcFileInitIOFile(opcIO_t *io, const xmlChar *filename, int flags);
-
-    /**
-      Initialize an IO for memory.
-      \warning Currently supports READ-ONLY file access.
-      */
-    opc_error_t opcFileInitIOMemory(opcIO_t *io, const opc_uint8_t *data, opc_uint32_t data_len, int flags);
-
-    /**
-      Cleanup an IO context, i.e. release all system resources.
-      */
-    opc_error_t opcFileCleanupIO(opcIO_t *io);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_FILE_H */

include/opc/helper.h

@@ -1,60 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/helper.h
-  Contains helper functions for the opc module.
-*/
-#include <opc/config.h>
-
-#ifndef OPC_HELPER_H
-#define OPC_HELPER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-
-    /**
-      Constructs a segment name.
-      */
-    opc_uint16_t opcHelperAssembleSegmentName(char *out, opc_uint16_t out_size, const xmlChar *name, opc_uint32_t segment_number, opc_uint32_t next_segment_id, opc_bool_t rels_segment, opc_uint16_t *out_max);
-
-    /**
-      Splits a filename into the segment informations.
-      */
-    opc_error_t opcHelperSplitFilename(opc_uint8_t *filename, opc_uint32_t filename_length, opc_uint32_t *segment_number, opc_bool_t *last_segment, opc_bool_t *rel_segment);
-
-#endif /* OPC_HELPER_H */

include/opc/inputstream.h

@@ -1,74 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/inputstream.h
- 
- */
-#include <opc/config.h>
-
-#ifndef OPC_INPUTSTREAM_H
-#define OPC_INPUTSTREAM_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-    /**
-      Internal type which represents a binary input stream.
-      */
-    typedef struct OPC_CONTAINER_INPUTSTREAM_STRUCT opcContainerInputStream;
-
-    /**
-      Opens the part \c name of the \c container for reading.
-      */
-    opcContainerInputStream* opcContainerOpenInputStream(opcContainer *container, const xmlChar *name);
-
-    /**
-     Reads maximal \c buffer_len bytes from the input \c stream to \c buffer. 
-     \return The number of byes read or "0" in case of an error or end-of-stream.
-     */
-    opc_uint32_t opcContainerReadInputStream(opcContainerInputStream* stream, opc_uint8_t *buffer, opc_uint32_t buffer_len);
-
-    /**
-      Closes the input stream and releases all system resources.
-      */
-    opc_error_t opcContainerCloseInputStream(opcContainerInputStream* stream);
-
-    /**
-      Returns the type of compression used for the stream.
-      */
-    opcCompressionOption_t opcContainerGetInputStreamCompressionOption(opcContainerInputStream* stream);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_INPUTSTREAM_H */

include/opc/opc.h

@@ -1,73 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/opc.h
- The opc module contains the basic library functions.
-*/
-#include <opc/config.h>
-#include <opc/container.h>
-#include <opc/part.h>
-#include <opc/relation.h>
-#include <opc/inputstream.h>
-#include <opc/outputstream.h>
-#include <opc/zip.h>
-#include <opc/xmlreader.h>
-#include <opc/xmlwriter.h>
-#include <opc/properties.h>
-
-#ifndef OPC_OPC_H
-#define OPC_OPC_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-    
-    /**
-     * Initialize libopc.
-     * Sample:
-     * \include opc_helloworld.c
-     * @return Non-zero if successful.
-     */
-    opc_error_t opcInitLibrary();
-
-    /**
-     * Free libopc. Clean up all resources.
-     * @return Non-zero if successful.
-     * \see opcInitLibrary.
-     */
-    opc_error_t opcFreeLibrary();
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_OPC_H */

include/opc/outputstream.h

@@ -1,71 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/outputstream.h
- 
- */
-#include <opc/config.h>
-
-#ifndef OPC_OUTPUTSTREAM_H
-#define OPC_OUTPUTSTREAM_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-    /**
-      Internal type which represents a binary output stream.
-      */
-    typedef struct OPC_CONTAINER_OUTPUTSTREAM_STRUCT opcContainerOutputStream;
-
-    /** 
-      Open the part \c name or writing in \c container with compression \c compression_option.
-      \note Make sure the part exists! 
-      \see opcPartCreate.
-      */
-    opcContainerOutputStream* opcContainerCreateOutputStream(opcContainer *container, const xmlChar *name, opcCompressionOption_t compression_option);
-
-    /**
-      Write \c buffer_len bytes from \c buffer to \c stream. 
-      \return Returns the number of bytes written.
-      */
-    opc_uint32_t opcContainerWriteOutputStream(opcContainerOutputStream* stream, const opc_uint8_t *buffer, opc_uint32_t buffer_len);
-
-    /**
-      Close the \c stream and free all associated resources.
-      */
-    opc_error_t opcContainerCloseOutputStream(opcContainerOutputStream* stream);
-        
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_OUTPUTSTREAM_H */

include/opc/part.h

@@ -1,118 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/part.h
- 
- */
-#include <opc/config.h>
-
-#ifndef OPC_PART_H
-#define OPC_PART_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-    /**
-     Handle to an OPC part created by \ref opcPartOpen.
-     \see opcPartOpen.
-     */
-    typedef xmlChar* opcPart;
-
-/**
-  Represents an invalid (resp. NULL) part.
-  In releations OPC_PART_INVALID also represents the root part.
-  \hideinitializer
-  */
-#define OPC_PART_INVALID NULL
-
-    /**
-     Find a part in a \ container by \c absolutePath and/or \c type.
-     Currently no flags are supported.
-     */
-    opcPart opcPartFind(opcContainer *container, 
-                        const xmlChar *absolutePath, 
-                        const xmlChar *type,
-                        int flags);
-
-    /**
-     Creates a part in a \ container with \c absolutePath and \c type.
-     Currently no flags are supported.
-     */
-    opcPart opcPartCreate(opcContainer *container, 
-                          const xmlChar *absolutePath, 
-                          const xmlChar *type,
-                          int flags);
-
-    /**
-      Returns the type of the container.
-      The string is interned and must not be freed.
-      */
-    const xmlChar *opcPartGetType(opcContainer *c, opcPart part);
-
-    /**
-      Returns the type of the container. 
-      If \c override_only then the return value will be NULL for parts not having an override type.
-      The string is interned and must not be freed.
-      */
-    const xmlChar *opcPartGetTypeEx(opcContainer *c, opcPart part, opc_bool_t override_only);
-
-    /**
-     Deleted that part \c absolutePath in the \c container.
-     */
-    opc_error_t opcPartDelete(opcContainer *container, const xmlChar *absolutePath);
-
-    /**
-      Get the first part.
-      \code
-      for(opcPart part=opcPartGetFirst(c);OPC_PART_INVALID!=part;part=opcPartGetNext(c, part)) {
-        printf("%s; \n", part, opcPartGetType(c, part));
-      }
-      \endcode 
-      */
-    opcPart opcPartGetFirst(opcContainer *container);
-
-    /**
-     Get the next part.
-     \see opcPartGetFirst
-      */
-    opcPart opcPartGetNext(opcContainer *container, opcPart part);
-
-    /**
-      Returns the size in bytes of the \c part.
-      */
-    opc_ofs_t opcPartGetSize(opcContainer *c, opcPart part);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_PART_H */

include/opc/properties.h

@@ -1,121 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/properties.h
- 
- */
-#include <opc/config.h>
-#include <opc/container.h>
-
-#ifndef OPC_PROPERTIES_H
-#define OPC_PROPERTIES_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-    /** 
-      Represents a simple Dublin Core type.
-      */
-    typedef struct OPC_DC_SIMPLE_TYPE {
-        xmlChar *str;
-        xmlChar *lang;
-    } opcDCSimpleType_t;
-
-    /** 
-      Represents the core properties of an OPC container.
-      */
-    typedef struct OPC_PROPERTIES_STRUCT {
-        xmlChar *category;                /* xsd:string     */
-        xmlChar *contentStatus;           /* xsd:string     */
-        xmlChar *created;                 /* dc:date        */
-        opcDCSimpleType_t creator;        /* dc:any         */
-        opcDCSimpleType_t description;    /* dc:any         */
-        opcDCSimpleType_t identifier;     /* dc:any         */
-        opcDCSimpleType_t *keyword_array; /* cp:CT_Keywords */
-        opc_uint32_t keyword_items;
-        opcDCSimpleType_t language;       /* dc:any         */
-        xmlChar *lastModifiedBy;          /* xsd:string     */
-        xmlChar *lastPrinted;             /* xsd:dateTime   */
-        xmlChar *modified;                /* dc:date        */
-        xmlChar *revision;                /* xsd:string     */
-        opcDCSimpleType_t subject;        /* dc:any         */
-        opcDCSimpleType_t title;          /* dc:any         */
-        xmlChar *version;                 /* xsd:string     */
-    } opcProperties_t;
-
-    /**
-      Initialize the core properties \c cp.
-      \see opcCorePropertiesSetString
-      */
-    opc_error_t opcCorePropertiesInit(opcProperties_t *cp);
-
-    /**
-      Cleanup the core properties \c cp, i.e. release all resources.
-      \see opcCorePropertiesSetString
-      */
-    opc_error_t opcCorePropertiesCleanup(opcProperties_t *cp);
-
-    /**
-      Rease the core properties \c cp from the container \c.
-      */
-    opc_error_t opcCorePropertiesRead(opcProperties_t *cp, opcContainer *c);
-
-
-    /**
-      Write/Update the core properties \c cp in the container \c.
-      */
-    opc_error_t opcCorePropertiesWrite(opcProperties_t *cp, opcContainer *c);
-
-    /**
-      Update a string in the core properties the right way.
-      \code
-      opcProperties_t cp;
-      opcCorePropertiesInit(&cp);
-      opcCorePropertiesSetString(&cp.revision, "1");
-      opcCorePropertiesSetStringLang(&cp.creator, "Florian Reuter", NULL);
-      opcCorePropertiesCleanup(&cp);
-      \endcode
-      */
-    opc_error_t opcCorePropertiesSetString(xmlChar **prop, const xmlChar *str);
-
-    /** 
-      Update a core properties the right way.
-      \see opcCorePropertiesSetString
-      */
-    opc_error_t opcCorePropertiesSetStringLang(opcDCSimpleType_t *prop, const xmlChar *str, const xmlChar *lang);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_PROPERTIES_H */

include/opc/relation.h

@@ -1,140 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/relation.h
- 
- */
-#include <opc/config.h>
-
-#ifndef OPC_RELATION_H
-#define OPC_RELATION_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-    /**
-     Indentifier for an OPC relation.
-     */
-    typedef opc_uint32_t opcRelation;
-
-/**
-  Constant which represents an invalid relation.
-*/
-#define OPC_RELATION_INVALID (-1)
-
-    /**
-      Find a relation originating from \c part in \c container with \c relationId and/or \c mimeType.
-      If \c part is OPC_PART_INVALID then part represents the root part.
-      @param[in] relationId The relationId (e.g. "rId1") or NULL.
-      @param[in] mimeType The mimeType or NULL.
-      */
-    opcRelation opcRelationFind(opcContainer *container, opcPart part, const xmlChar *relationId, const xmlChar *mimeType);
-
-    /**
-      Deleted the relation from the container.
-      \see opcRelationFind.
-      */
-    opc_error_t opcRelationDelete(opcContainer *container, opcPart part, const xmlChar *relationId, const xmlChar *mimeType);
-
-    /**
-      Returns the first relation.
-      The following code will dump all relations:
-      \code
-        for(opcPart part=opcPartGetFirst(c);OPC_PART_INVALID!=part;part=opcPartGetNext(c, part)) {
-           for(opcRelation rel=opcRelationFirst(part, c);
-               OPC_PART_INVALID!=rel;
-               rel=opcRelationNext(c, rel)) {
-               opcPart internal_target=opcRelationGetInternalTarget(c, part, rel);
-               const xmlChar *external_target=opcRelationGetExternalTarget(c, part, rel);
-               const xmlChar *target=(NULL!=internal_target?internal_target:external_target);
-               const xmlChar *prefix=NULL;
-               opc_uint32_t counter=-1;
-               const xmlChar *type=NULL;
-               opcRelationGetInformation(c, part, rel, &prefix, &counter, &type);        
-               if (-1==counter) { // no counter after prefix
-                  printf("%s;%s;%s;%s\n", part, prefix, target, type);
-               } else {
-                  printf("%s;%s%i;%s;%s\n", part, prefix, counter, target, type);
-               }
-           }
-        }
-      \endcode
-      */
-    opcRelation opcRelationFirst(opcContainer *container, opcPart part);
-
-    /**
-      \see opcRelationFirst
-      */
-    opcRelation opcRelationNext(opcContainer *container, opcPart part, opcRelation relation);
-    
-    /**
-      Returns the internal target.
-      \note To test for an external target use opcRelationGetExternalTarget.
-      \see opcRelationGetExternalTarget
-      */
-    opcPart opcRelationGetInternalTarget(opcContainer *container, opcPart part, opcRelation relation);
-
-    /**
-      Returns the external target or NULL if it is an internal target.
-      The string is interned. Must not be freed.
-      \see opcRelationGetExternalTarget
-      */
-    const xmlChar *opcRelationGetExternalTarget(opcContainer *container, opcPart part, opcRelation relation);
-
-    /**
-      Returns the relations type.
-      The string is interned. Must not be freed.
-      */
-    const xmlChar *opcRelationGetType(opcContainer *container, opcPart part, opcRelation relation);
-
-    /** 
-      Get information about a relation.
-      \see opcRelationFirst
-      */
-    void opcRelationGetInformation(opcContainer *container, opcPart part, opcRelation relation, const xmlChar **prefix, opc_uint32_t *counter, const xmlChar **type);
-
-    /** 
-      Add a relation to \c container from \c src part to \c dest part with id \c rid and type \c type.
-      */
-    opc_uint32_t opcRelationAdd(opcContainer *container, opcPart src, const xmlChar *rid, opcPart dest, const xmlChar *type);
-
-    /** 
-      Add an external relation to \c container from \c src part to \c target URL with id \c rid and type \c type.
-      */
-    opc_uint32_t opcRelationAddExternal(opcContainer *container, opcPart src, const xmlChar *rid, const xmlChar *target, const xmlChar *type);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-
-#endif /* OPC_RELATION_H */

include/opc/xmlreader.h

@@ -1,69 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/xmlreader.h
- 
- */
-
-#ifndef OPC_XMLREADER_H
-#define OPC_XMLREADER_H
-
-#include <opc/config.h>
-#include <libxml/xmlreader.h>
-#include <mce/textreader.h>
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-    /** 
-      Open an MCE reader for \c partName. Parameters \c URL, \c encoding and \c options will be passed unmodified to 
-      http://xmlsoft.org/html/libxml-xmlreader.html#xmlReaderForIO and they can we NULL, NULL, 0.
-      \note Make sure the part exists.
-      \see opcPartFind
-      */
-    opc_error_t opcXmlReaderOpen(opcContainer *container, mceTextReader_t *mceTextReader, const xmlChar *partName, const char * URL, const char * encoding, int options);
-
-    /**
-      Returns an libxml DOM document. Parameters \c URL, \c encoding and \c options will be passed unmodified to 
-      http://xmlsoft.org/html/libxml-parser.html#xmlReadIO and they can we NULL, NULL, 0.
-      \note Make sure the part exists.
-      \see opcPartFind
-      */
-    xmlDocPtr opcXmlReaderReadDoc(opcContainer *container, const xmlChar *partName, const char * URL, const char * encoding, int options);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_XMLREADER_H */

include/opc/xmlwriter.h

@@ -1,57 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/xmlwriter.h
- 
- */
-#include <opc/config.h>
-#include <mce/textwriter.h>
-
-#ifndef OPC_XMLWRITER_H
-#define OPC_XMLWRITER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-    /**
-      Create an MCE text writer for \c part in \c container with compression \c compression_option.
-      \note Make sure the part exists.
-      \see opcPartFind
-      */
-    mceTextWriter *mceTextWriterOpen(opcContainer *c, opcPart part, opcCompressionOption_t compression_option);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_XMLWRITER_H */

include/opc/zip.h

@@ -1,255 +0,0 @@
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-/** @file opc/zip.h
-  The ZIP file backend of an OPC container.
- */
-#include <opc/config.h>
-#include <opc/file.h>
-#include <opc/container.h>
-
-#ifndef OPC_ZIP_H
-#define OPC_ZIP_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif    
-
-    /**
-     Default growth hint of an OPC stream.
-     */
-    #define OPC_DEFAULT_GROWTH_HINT 512
-
-    /**
-     Handle to a ZIP archive.
-     \see internal.h
-     */
-    typedef struct OPC_ZIP_STRUCT opcZip;
-
-    /**
-      Handle to a raw ZIP input stream.
-     \see internal.h
-      */
-    typedef struct OPC_ZIPINPUTSTREAM_STRUCT opcZipInputStream;
-
-    /**
-      Handle to a raw ZIP output stream.
-     \see internal.h
-      */
-    typedef struct OPC_ZIPOUTPUTSTREAM_STRUCT opcZipOutputStream;
-
-    /**
-     Holds all information of a ZIP segment.
-     */
-    typedef struct OPC_ZIP_SEGMENT_INFO_STRUCT {
-        xmlChar name[OPC_MAX_PATH]; 
-        opc_uint32_t name_len;
-        opc_uint32_t segment_number;
-        opc_bool_t   last_segment;
-        opc_bool_t   rels_segment;
-        opc_uint32_t header_size;
-        opc_uint32_t min_header_size;
-        opc_uint32_t trailing_bytes;
-        opc_uint32_t compressed_size;
-        opc_uint32_t uncompressed_size;
-        opc_uint16_t bit_flag;
-        opc_uint32_t data_crc;
-        opc_uint16_t compression_method;
-        opc_ofs_t    stream_ofs;
-        opc_uint16_t growth_hint;
-    } opcZipSegmentInfo_t;
-
-    /**
-      \see opcZipLoader
-      */
-    typedef int opcZipLoaderOpenCallback(void *iocontext);
-    /**
-      \see opcZipLoader
-      */
-    typedef int opcZipLoaderSkipCallback(void *iocontext);
-    /**
-      \see opcZipLoader
-      */
-    typedef int opcZipLoaderReadCallback(void *iocontext, char *buffer, int len);
-    /**
-      \see opcZipLoader
-      */
-    typedef int opcZipLoaderCloseCallback(void *iocontext);
-
-    /**
-      \see opcZipLoader
-      */
-    typedef opc_error_t (opcZipLoaderSegmentCallback_t)(void *iocontext, void *userctx, opcZipSegmentInfo_t *info, opcZipLoaderOpenCallback *open, opcZipLoaderReadCallback *read, opcZipLoaderCloseCallback *close, opcZipLoaderSkipCallback *skip);
-
-    /**
-      Walks every segment in a ZIP archive and calls the \c segmentCallback callback method.
-      The implementer \c segmentCallback method must then eiher use the passed \c open, \c read and \c close methods
-      to read the stream or the passed \c skip methods to skip the stream.
-      This method can be used to e.g. read ZIP file in stream mode.
-      */
-    opc_error_t opcZipLoader(opcIO_t *io, void *userctx, opcZipLoaderSegmentCallback_t *segmentCallback);
-
-    /**
-      \see opcZipClose
-     */
-    typedef opc_error_t (opcZipSegmentReleaseCallback)(opcZip *zip, opc_uint32_t segment_id);
-
-    /** 
-     Closes the ZIP archive \c zip and will call \c releaseCallback for every segment to give the implementer a chance
-     to free user resources.
-     */
-    void opcZipClose(opcZip *zip, opcZipSegmentReleaseCallback* releaseCallback);
-
-    /**
-      Creates an empty ZIP archive with the given \c io.
-      */
-    opcZip *opcZipCreate(opcIO_t *io);
-
-    /**
-      Commits all buffers and writes the ZIP archives local header directories.
-      if \c trim is true then padding bytes will be removed, i.e. the ZIP file size fill be minimalized.
-     */
-    opc_error_t opcZipCommit(opcZip *zip, opc_bool_t trim);
-
-    /**
-      Garbage collection on the passed \c zip archive. This will e.g. make deleted files available as free space.
-      */
-    opc_error_t opcZipGC(opcZip *zip);
-
-    /**
-      Load segment information into \c info.
-      If \c rels_segment is -1 then load the info for part with name \c partName.
-      Otherwise load the segment information for the ".rels." segment of \c partName.
-      \return Returns the segment_id.
-      */
-    opc_uint32_t opcZipLoadSegment(opcZip *zip, const xmlChar *partName, opc_bool_t rels_segment, opcZipSegmentInfo_t *info);
-
-    /**
-      Create a segment with the given parameters.
-      \return Returns the segment_id.
-      */
-    opc_uint32_t opcZipCreateSegment(opcZip *zip, 
-                                     const xmlChar *partName, 
-                                     opc_bool_t relsSegment, 
-                                     opc_uint32_t segment_size, 
-                                     opc_uint32_t growth_hint,
-                                     opc_uint16_t compression_method,
-                                     opc_uint16_t bit_flag);
-
-    /**
-      Creates an input stream for the segment with \c segment_id.
-      \see opcZipLoadSegment
-      \see opcZipCreateSegment
-      */
-    opcZipInputStream *opcZipOpenInputStream(opcZip *zip, opc_uint32_t segment_id);
-
-    /**
-     Free all resources of the input stream.
-     */
-    opc_error_t opcZipCloseInputStream(opcZip *zip, opcZipInputStream *stream);
-
-    /**
-     Read maximal \c buf_len bytes from the input stream into \buf. 
-     \return Returns the number of bytes read.
-     */
-    opc_uint32_t opcZipReadInputStream(opcZip *zip, opcZipInputStream *stream, opc_uint8_t *buf, opc_uint32_t buf_len);
-
-
-    /**
-      Creates an output stream for the segment with \c segment_id.
-      If \c *segment_id is -1 then a new segment will be created. 
-      Otherwise the segment with \c *segment_id will be overwritten.
-     */
-    opcZipOutputStream *opcZipCreateOutputStream(opcZip *zip, 
-                                             opc_uint32_t *segment_id, 
-                                             const xmlChar *partName, 
-                                             opc_bool_t relsSegment, 
-                                             opc_uint32_t segment_size, 
-                                             opc_uint32_t growth_hint,
-                                             opc_uint16_t compression_method,
-                                             opc_uint16_t bit_flag);
-
-    /**
-      Opens an existing ouput stream for reading.
-      The \c *segment_id will be set to -1 and reset on opcZipCloseOutputStream.
-      \see opcZipCloseOutputStream
-     */
-    opcZipOutputStream *opcZipOpenOutputStream(opcZip *zip, opc_uint32_t *segment_id);
-
-    /** 
-      Will close the stream and free all resources. Additionally the new segment id will be stored in \c *segment_id.
-      \see opcZipOpenOutputStream
-      */
-    opc_error_t opcZipCloseOutputStream(opcZip *zip, opcZipOutputStream *stream, opc_uint32_t *segment_id);
-
-    /**
-     Write \c buf_len bytes to \c buf. 
-     \return Returns the number of bytes written.
-     */
-    opc_uint32_t opcZipWriteOutputStream(opcZip *zip, opcZipOutputStream *stream, const opc_uint8_t *buf, opc_uint32_t buf_len);
-
-    /**
-     Returns the first segment id or -1.
-     Use the following code to iterarte through all segments.
-     \code 
-     for(opc_uint32_t segment_id=opcZipGetFirstSegmentId(zip);
-         -1!=segment_id;
-         segment_id=opcZipGetNextSegmentId(zip, segment_id) {
-        ...
-     }
-     \endcode
-     \see opcZipGetNextSegmentId
-     */
-    opc_uint32_t opcZipGetFirstSegmentId(opcZip *zip);
-
-    /**
-     Returns the next segment id or -1.
-     \see opcZipGetFirstSegmentId
-     */
-    opc_uint32_t opcZipGetNextSegmentId(opcZip *zip, opc_uint32_t segment_id);
-
-    /**
-     Returns info about the given segment id.
-     */
-    opc_error_t opcZipGetSegmentInfo(opcZip *zip, opc_uint32_t segment_id, const xmlChar **name, opc_bool_t *rels_segment, opc_uint32_t *crc);
-
-    /**
-     Marks a given segments as deleted.
-     \see opcZipGC
-     */
-    opc_bool_t opcZipSegmentDelete(opcZip *zip, opc_uint32_t *first_segment, opc_uint32_t *last_segment, opcZipSegmentReleaseCallback* releaseCallback);
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif    
-        
-#endif /* OPC_ZIP_H */

include/plib/plib.h

@@ -1,168 +0,0 @@
-/* include/plib/plib.h.  Generated from plib.h by configure.  */
-/*
- Copyright (c) 2010, Florian Reuter
- All rights reserved.
- 
- Redistribution and use in source and binary forms, with or without 
- modification, are permitted provided that the following conditions 
- are met:
- 
- * Redistributions of source code must retain the above copyright 
-   notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright 
-   notice, this list of conditions and the following disclaimer in 
-   the documentation and/or other materials provided with the 
-   distribution.
- * Neither the name of Florian Reuter nor the names of its contributors 
-   may be used to endorse or promote products derived from this 
-   software without specific prior written permission.
- 
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
- STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- OF THE POSSIBILITY OF SUCH DAMAGE.
- 
-*/
-#ifndef _PLIB_PLIB_H_
-#define _PLIB_PLIB_H_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define HAVE_STDINT_H 1
-#define HAVE_STDDEF_H 1
-#define HAVE_STDIO_H 1
-#define HAVE_STRING_H 1
-#define HAVE_LIMITS_H 1
-#define HAVE_STDLIB_H 1
-/* #undef HAVE_IO_H */
-#define HAVE_UNISTD_H 1
-#define HAVE_SYS_TYPES_H 1
-#define IS_CONFIGURED 1
-
-#if !defined(IS_CONFIGURED)
-#if defined(WIN32)
-#define HAVE_STRING_H 1
-#define HAVE_STDINT_H 1
-#define HAVE_LIMITS_H 1
-#define HAVE_STDDEF_H 1
-#define HAVE_STDIO_H 1
-#define HAVE_STDLIB_H 1
-#define HAVE_IO_H
-#define snprintf _snprintf
-#else
-#error "configure not executed and we are not on a win32 machine? please run configure or define WIN32 is you are on a WIN32 platform."
-#endif
-#endif
-
-#ifdef HAVE_STDDEF_H
-#include <stddef.h>
-typedef size_t pofs_t; // maximum file offset for eg. read write ops
-#else
-#error "system types can not be determined"
-#endif
-
-#ifdef HAVE_STDIO_H
-#include <stdio.h>
-#else
-#error "system io can not be determined"
-#endif
-
-#ifdef HAVE_STDINT_H
-#include <stdint.h>
-
-typedef int8_t pint8_t;
-typedef uint8_t puint8_t;
-
-typedef int16_t pint16_t;
-typedef uint16_t puint16_t;
-
-typedef int32_t pint32_t;
-typedef uint32_t puint32_t;
-
-typedef int64_t pint64_t;
-typedef uint64_t puint64_t;
-
-typedef int pbool_t;
-
-typedef size_t psize_t;
-
-// INTN_MAX, INTN_MIN, UINTN_MAX
-#else
-#error "system types can not be determined"
-#endif
-
-#ifdef HAVE_STRING_H
-#include <string.h>
-#endif
-
-#ifdef HAVE_LIMITS_H
-#include <limits.h>
-#define PUINT8_MAX UCHAR_MAX 
-#define PINT32_MAX INT_MAX 
-#define PINT32_MIN INT_MIN 
-#define PUINT32_MAX UINT_MAX 
-#define PUINT32_MIN 0 
-#define PUINT16_MAX	USHRT_MAX 
-#define PUINT16_MIN 0 
-#else
-#error "limits can not be determined"
-#endif
-
-#ifdef HAVE_STDLIB_H
-#include <stdlib.h>
-#endif
-
-#ifdef HAVE_IO_H
-#include <io.h>
-#endif
-
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-
-#ifdef HAVE_SYS_TYPES_H
-#include <sys/types.h>
-#endif
-
-/**
- Converts an ASCII string to a xmlChar string. This only works for ASCII strings.
- */
-#ifndef _X
-#define _X(s) BAD_CAST(s) 
-#endif
-
-
-/**
- Converts an xmlChar string to an ASCII string. This only works for ASCII charsets.
- */
-#ifndef _X2C
-#define _X2C(s) ((char*)(s))
-#endif
-
-
-#define PASSERT(e) assert(e)
-#ifdef NDEBUG
-#define PENSURE(e) (void)(e)
-#else
-#define PENSURE(e) assert(e)
-#endif
-#define PTRUE (0==0)
-#define PFALSE (0==1)
-
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-
-#endif /* _PLIB_PLIB_H_ */

mime.csv

@@ -252,7 +252,7 @@ text/html, acgi|htm|html|htmls|htx|shtml
 text/javascript, js
 text/mcf, mcf
 text/pascal, pas
-text/plain, com|cmd|conf|def|g|idc|list|lst|mar|sdml|text|txt|md|groovy|license|properties|desktop|ini|rst|cmake|ipynb|readme|less|lo|go|yml|d|cs|hpp|srt|nfo|sfv|m3u
+text/plain, com|cmd|conf|def|g|idc|list|lst|mar|sdml|text|txt|md|groovy|license|properties|desktop|ini|rst|cmake|ipynb|readme|less|lo|go|yml|d|cs|hpp|srt|nfo|sfv|m3u|csv|eml
 text/richtext, rt|rtf|rtx
 text/rtf,
 text/scriplet, wsc
@@ -320,7 +320,7 @@ video/x-dv, dif|dv
 video/x-fli, fli
 video/x-isvideo, isu
 video/x-motion-jpeg, mjpg
-video/x-ms-asf, asf|asx
+video/x-ms-asf, asf|asx|wmv
 video/x-qtc, qtc
 video/x-sgi-movie, movie|mv
 application/x-7z-compressed, 7z

schema/mappings.json

@@ -1,31 +1,40 @@
 {
   "properties": {
+    "_tie": {
+      "type": "keyword",
+      "doc_values": true
+    },
+    "_depth": {
+      "type": "integer"
+    },
     "path": {
       "type": "text",
       "analyzer": "path_analyzer",
-      "copy_to": "suggest-path"
-    },
-    "suggest-path": {
-      "type": "completion",
-      "analyzer": "keyword"
+      "fielddata": true,
+      "index_prefixes": {}
     },
     "mime": {
       "type": "keyword"
     },
     "videoc": {
-      "type": "keyword"
+      "type": "keyword",
+      "index": false
     },
     "audioc": {
-      "type": "keyword"
+      "type": "keyword",
+      "index": false
     },
     "duration": {
-      "type": "float"
+      "type": "float",
+      "index": false
     },
     "width": {
-      "type": "integer"
+      "type": "integer",
+      "index": false
     },
     "height": {
-      "type": "integer"
+      "type": "integer",
+      "index": false
     },
     "mtime": {
       "type": "integer"
@@ -70,6 +79,23 @@
       "analyzer": "my_nGram",
       "type": "text"
     },
+    "_keyword.*":  {
+      "type": "keyword"
+    },
+    "_text.*":  {
+      "analyzer": "content_analyzer",
+      "type": "text",
+      "fields": {
+        "nGram": {
+          "type": "text",
+          "analyzer": "my_nGram"
+        }
+      }
+    },
+    "_url": {
+      "type": "keyword",
+      "index": false
+    },
     "content": {
       "analyzer": "content_analyzer",
       "type": "text",
@@ -83,6 +109,30 @@
     },
     "tag": {
       "type": "keyword"
+    },
+    "exif_make": {
+      "type": "text"
+    },
+    "exif_model": {
+      "type": "text"
+    },
+    "exif:software": {
+      "type": "text"
+    },
+    "exif_exposure_time": {
+      "type": "keyword"
+    },
+    "exif_fnumber": {
+      "type": "keyword"
+    },
+    "exif_iso_speed_ratings": {
+      "type": "keyword"
+    },
+    "exif_focal_length": {
+      "type": "keyword"
+    },
+    "exif_user_comment": {
+      "type": "text"
     }
   }
 }

schema/pipeline.json

@@ -0,0 +1,10 @@
+{
+  "description": "Copy _id to _tie, save path depth",
+  "processors": [
+    {
+      "script": {
+        "source": "ctx._tie = ctx._id; ctx._depth = ctx.path.length() == 0 ? 0 : 1 + ctx.path.length() - ctx.path.replace(\"/\", \"\").length();"
+      }
+    }
+  ]
+}

schema/settings.json

@@ -21,6 +21,12 @@
           "lowercase"
         ]
       },
+      "case_insensitive_kw_analyzer": {
+        "tokenizer": "keyword",
+        "filter": [
+          "lowercase"
+        ]
+      },
       "my_nGram": {
         "tokenizer": "my_nGram_tokenizer",
         "filter": [

scripting/README.md

@@ -54,6 +54,11 @@ script.painless.regex.enabled: true
 ```
 Or, if you're using docker add `-e "script.painless.regex.enabled=true"`
 
+**Tag color**
+
+You can specify the color for an individual tag by appending an 
+hexadecimal color code (`#RRGGBBAA`) to the tag name.
+
 ### Examples
 
 If `(20XX)` is in the file name, add the `year.<year>` tag:
@@ -115,3 +120,33 @@ if (ctx._source.path != "") {
     tags.add("studio." + names[names.length-1]);
 }
 ```
+
+Parse `EXIF:F Number` tag
+```Java
+if (ctx._source?.exif_fnumber != null) {
+    String[] values = ctx._source.exif_fnumber.splitOnToken(' ');
+    String aperture = String.valueOf(Float.parseFloat(values[0]) / Float.parseFloat(values[1]));
+    if (aperture == "NaN") {
+        aperture = "0,0";
+    }
+    tags.add("Aperture.f/" + aperture.replace(".", ","));
+}
+```
+
+Display year and months from `EXIF:DateTime` tag
+```Java
+if (ctx._source?.exif_datetime != null) {
+    SimpleDateFormat parser = new SimpleDateFormat("yyyy:MM:dd HH:mm:ss");
+    Date date = parser.parse(ctx._source.exif_datetime);
+
+    SimpleDateFormat yp = new SimpleDateFormat("yyyy");
+    SimpleDateFormat mp = new SimpleDateFormat("MMMMMMMMM");
+
+    String year = yp.format(date);
+    String month = mp.format(date);
+
+    tags.add("Month." + month);
+    tags.add("Year." + year);
+}
+
+```

scripts/get_static_libs.sh

@@ -1,8 +1,11 @@
 #!/usr/bin/env bash
+
+THREADS=$(nproc)
+
 cd lib
 
 cd mupdf
-USE_SYSTEM_HARFBUZZ=yes USE_SYSTEM_OPENJPEG=yes HAVE_X11=no HAVE_GLUT=no make -j 4
+CFLAGS=-fPIC make USE_SYSTEM_HARFBUZZ=yes USE_SYSTEM_OPENJPEG=yes HAVE_X11=no HAVE_GLUT=no -j $THREADS
 cd ..
 
 mv mupdf/build/release/libmupdf.a .
@@ -10,17 +13,16 @@ mv mupdf/build/release/libmupdf-third.a .
 
 # openjp2
 cd openjpeg
-#cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-O3 -march=native -DNDEBUG"
-cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-O3"
-make -j 4
+cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-O3 -DNDEBUG -fPIC"
+make -j $THREADS
 cd ..
 mv openjpeg/bin/libopenjp2.a .
 
 # harfbuzz
 cd harfbuzz
 ./autogen.sh
-./configure --disable-shared --enable-static
-make -j 4
+CFLAGS=-fPIC ./configure --disable-shared --enable-static
+make -j $THREADS
 cd ..
 mv harfbuzz/src/.libs/libharfbuzz.a .
 
@@ -30,8 +32,9 @@ cd ffmpeg
  --disable-ffprobe --disable-doc\
  --disable-manpages --disable-postproc --disable-avfilter \
  --disable-alsa --disable-lzma --disable-xlib --disable-debug\
- --disable-vdpau --disable-vaapi --disable-sdl2 --disable-network
-make -j 4
+ --disable-vdpau --disable-vaapi --disable-sdl2 --disable-network\
+ --extra-cflags=-fPIC
+make -j $THREADS
 cd ..
 
 mv ffmpeg/libavcodec/libavcodec.a .
@@ -48,14 +51,14 @@ cmake -DONION_USE_SSL=false -DONION_USE_PAM=false -DONION_USE_PNG=false -DONION_
 -DONION_USE_JPEG=false -DONION_USE_XML2=false -DONION_USE_SYSTEMD=false -DONION_USE_SQLITE3=false \
 -DONION_USE_REDIS=false -DONION_USE_GC=false -DONION_USE_TESTS=false -DONION_EXAMPLES=false \
 -DONION_USE_BINDINGS_CPP=false ..
-make -j 4
+make -j $THREADS
 cd ../..
 
 mv onion/build/src/onion/libonion_static.a .
 
 #bzip2
 cd bzip2-1.0.6
-make -j 4
+make -j $THREADS
 cd ..
 mv bzip2-1.0.6/libbz2.a .
 
@@ -63,47 +66,63 @@ mv bzip2-1.0.6/libbz2.a .
 cd libmagic
 ./autogen.sh
 ./configure --enable-static --disable-shared
-make -j 4
+make -j $THREADS
 cd ..
 mv libmagic/src/.libs/libmagic.a .
 
-# libarchive
-cd libarchive/build
+# tesseract
+cd tesseract
+mkdir build
+cd build
+cmake -DSTATIC=on -DBUILD_TRAINING_TOOLS=off -DBUILD_TESTS=off -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_CXX_FLAGS="-fPIC" -DAUTO_OPTIMIZE=off ..
+make -j $THREADS
+cd ../..
+mv tesseract/build/libtesseract.a .
+
+# leptonica
+cd leptonica
 ./autogen.sh
+CFLAGS="-fPIC" ./configure --without-zlib --without-jpeg --without-giflib \
+  --without-giflib --without-libwebp --without-libwebpmux --without-libopenjpeg \
+  --enable-static --disable-shared
+make -j $THREADS
 cd ..
-./configure --without-nettle --without-expat --without-xml2 --without-openssl
-make -j 4
-cd ..
-mv libarchive/.libs/libarchive.a .
+mv leptonica/src/.libs/liblept.a .
 
-# lz4
-cd lz4
-make -j 4
-cd ..
-mv lz4/lib/liblz4.a .
-
-# lzma
-wget https://newcontinuum.dl.sourceforge.net/project/lzmautils/xz-5.2.3.tar.gz
-tar -xzf xz-5.2.3.tar.gz
-rm xz-5.2.3.tar.gz
-cd xz-5.2.3
+# tiff
+cd libtiff
 ./autogen.sh
-./configure
-make -j 4
+CFLAGS="-fPIC" CXXFLAGS="-fPIC" CXX_FLAGS="-fPIC" ./configure --enable-static --disable-shared --disable-lzw --disable-jpeg --disable-webp \
+  --disable-lzma --disable-zstd --disable-jbig
+make -j $THREADS
 cd ..
-mv xz-5.2.3/src/liblzma/.libs/liblzma.a .
+mv libtiff/libtiff/.libs/libtiff.a .
 
-# zstd
-cd zstd
-make -j 4
+# png
+cd libpng
+CFLAGS="-fPIC" ./configure --enable-static --disable-shared
+make -j $THREADS
 cd ..
-mv zstd/lib/libzstd.a .
+mv libpng/.libs/libpng16.a .
 
-# xml2
-cd libxml2
-./autogen.sh --without-zlib --without-lzma
-make
+# openssl...
+git clone --depth 1 -b OpenSSL_1_1_0-stable https://github.com/openssl/openssl
+cd openssl
+./config --prefix=$(pwd)/../ssl
+make depend
+make -j $THREADS
+make install
 cd ..
-mv libxml2/.libs/libxml2.a .
+mv ./openssl/libcrypto.a ./openssl/libssl.a .
 
+# curl
+wget -nc https://curl.haxx.se/download/curl-7.68.0.tar.gz
+tar -xzf curl-7.68.0.tar.gz
+cd curl-7.68.0
+./configure --disable-ldap --disable-ldaps --without-librtmp --disable-rtsp --disable-crypto-auth \
+  --disable-smtp --without-libidn2 --without-nghttp2 --without-brotli --enable-static --disable-shared \
+  --without-libpsl --with-ssl=$(pwd)/../ssl
+make -j $THREADS
 cd ..
+mv curl-7.68.0/lib/.libs/libcurl.a .

scripts/get_static_libs_freebsd.sh

@@ -1,58 +0,0 @@
-#!/usr/bin/env bash
-cd lib
-
-# mupdf
-cd mupdf
-HAVE_X11=no HAVE_GLUT=no gmake -j 4
-cd ..
-
-mv mupdf/build/release/libmupdf.a .
-mv mupdf/build/release/libmupdf-third.a .
-
-# openjp2
-cd openjpeg
-#cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-O3 -march=native -DNDEBUG"
-cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-O3"
-gmake -j 4
-cd ..
-mv openjpeg/bin/libopenjp2.a .
-
-# harfbuzz
-cd harfbuzz
-./autogen.sh
-./configure --disable-shared --enable-static
-gmake -j 4
-cd ..
-mv harfbuzz/src/.libs/libharfbuzz.a .
-
-# ffmpeg
-cd ffmpeg
-./configure --disable-shared --enable-static --disable-ffmpeg --disable-ffplay \
- --disable-ffprobe --disable-doc\
- --disable-manpages --disable-postproc --disable-avfilter \
- --disable-alsa --disable-lzma --disable-xlib --disable-debug\
- --disable-vdpau --disable-vaapi --disable-sdl2 --disable-network
-gmake -j 4
-cd ..
-
-mv ffmpeg/libavcodec/libavcodec.a .
-mv ffmpeg/libavformat/libavformat.a .
-mv ffmpeg/libavutil/libavutil.a .
-mv ffmpeg/libswresample/libswresample.a .
-mv ffmpeg/libswscale/libswscale.a .
-
-#bzip2
-cd bzip2-1.0.6
-make -j 4
-cd ..
-mv bzip2-1.0.6/libbz2.a .
-
-# magic
-cd libmagic
-./autogen.sh
-./configure --enable-static --disable-shared
-make -j 4
-cd ..
-mv libmagic/src/.libs/libmagic.a .
-
-cd ..

scripts/index_static.py

@@ -1,6 +1,9 @@
+import json
+
 files = [
     "schema/mappings.json",
     "schema/settings.json",
+    "schema/pipeline.json",
 ]
 
 
@@ -9,6 +12,6 @@ def clean(filepath):
 
 
 for file in files:
-    with open(file, "rb") as f:
-        data = f.read()
+    with open(file, "r") as f:
+        data = json.dumps(json.load(f), separators=(",", ":")).encode()
     print("char %s[%d] = {%s};" % (clean(file), len(data), ",".join(str(int(b)) for b in data)))

src/cli.c

@@ -1,4 +1,5 @@
 #include "cli.h"
+#include "ctx.h"
 
 #define DEFAULT_OUTPUT "index.sist2/"
 #define DEFAULT_CONTENT_SIZE 32768
@@ -12,6 +13,13 @@
 #define DEFAULT_BIND_ADDR "localhost"
 #define DEFAULT_PORT "4090"
 
+const char* TESS_DATAPATHS[] = {
+        "/usr/share/tessdata/",
+        "/usr/share/tesseract-ocr/tessdata/",
+        "./",
+        NULL
+};
+
 
 scan_args_t *scan_args_create() {
     scan_args_t *args = calloc(sizeof(scan_args_t), 1);
@@ -34,8 +42,6 @@ void scan_args_destroy(scan_args_t *args) {
     free(args);
 }
 
-#ifndef SIST_SCAN_ONLY
-
 void index_args_destroy(index_args_t *args) {
     //todo
     free(args);
@@ -46,8 +52,6 @@ void web_args_destroy(web_args_t *args) {
     free(args);
 }
 
-#endif
-
 int scan_args_validate(scan_args_t *args, int argc, const char **argv) {
     if (argc < 2) {
         fprintf(stderr, "Required positional argument: PATH.\n");
@@ -65,8 +69,8 @@ int scan_args_validate(scan_args_t *args, int argc, const char **argv) {
     if (args->incremental != NULL) {
         abs_path = abspath(args->incremental);
         if (abs_path == NULL) {
-            fprintf(stderr, "File not found: %s\n", args->incremental);
-            return 1;
+            sist_log("main.c", SIST_WARNING, "Could not open original index! Disabled incremental scan feature.");
+            args->incremental = NULL;
         }
     }
 
@@ -134,13 +138,71 @@ int scan_args_validate(scan_args_t *args, int argc, const char **argv) {
         fprintf(stderr, "Archive mode must be one of (skip, list, shallow, recurse), got '%s'", args->archive);
         return 1;
     }
+
+    if (args->tesseract_lang != NULL) {
+        TessBaseAPI *api = TessBaseAPICreate();
+
+        char filename[128];
+        sprintf(filename, "%s.traineddata", args->tesseract_lang);
+        const char * path = find_file_in_paths(TESS_DATAPATHS, filename);
+        if (path == NULL) {
+            LOG_FATAL("cli.c", "Could not find tesseract language file!");
+        }
+
+        ret = TessBaseAPIInit3(api, path, args->tesseract_lang);
+        if (ret != 0) {
+            fprintf(stderr, "Could not initialize tesseract with lang '%s'\n", args->tesseract_lang);
+            return 1;
+        }
+        TessBaseAPIEnd(api);
+        TessBaseAPIDelete(api);
+
+        args->tesseract_path = path;
+    }
+
+    if (args->exclude_regex != NULL) {
+        const char *error;
+        int error_offset;
+
+        pcre *re = pcre_compile(args->exclude_regex, 0, &error, &error_offset, 0);
+        if (error != NULL) {
+            LOG_FATALF("cli.c", "pcre_compile returned error: %s (offset:%d)", error, error_offset)
+        }
+
+        pcre_extra *re_extra = pcre_study(re, 0, &error);
+        if (error != NULL) {
+            LOG_FATALF("cli.c", "pcre_study returned error: %s", error)
+        }
+
+        ScanCtx.exclude = re;
+        ScanCtx.exclude_extra = re_extra;
+    } else {
+        ScanCtx.exclude = NULL;
+    }
+
+    LOG_DEBUGF("cli.c", "arg quality=%f", args->quality)
+    LOG_DEBUGF("cli.c", "arg size=%d", args->size)
+    LOG_DEBUGF("cli.c", "arg content_size=%d", args->content_size)
+    LOG_DEBUGF("cli.c", "arg threads=%d", args->threads)
+    LOG_DEBUGF("cli.c", "arg incremental=%s", args->incremental)
+    LOG_DEBUGF("cli.c", "arg output=%s", args->output)
+    LOG_DEBUGF("cli.c", "arg rewrite_url=%s", args->rewrite_url)
+    LOG_DEBUGF("cli.c", "arg name=%s", args->name)
+    LOG_DEBUGF("cli.c", "arg depth=%d", args->depth)
+    LOG_DEBUGF("cli.c", "arg path=%s", args->path)
+    LOG_DEBUGF("cli.c", "arg archive=%s", args->archive)
+    LOG_DEBUGF("cli.c", "arg tesseract_lang=%s", args->tesseract_lang)
+    LOG_DEBUGF("cli.c", "arg tesseract_path=%s", args->tesseract_path)
+    LOG_DEBUGF("cli.c", "arg exclude=%s", args->exclude_regex)
+    LOG_DEBUGF("cli.c", "arg fast=%d", args->fast)
+
     return 0;
 }
 
-#ifndef SIST_SCAN_ONLY
-
 int index_args_validate(index_args_t *args, int argc, const char **argv) {
 
+    LogCtx.verbose = 1;
+
     if (argc < 2) {
         fprintf(stderr, "Required positional argument: PATH.\n");
         return 1;
@@ -176,7 +238,7 @@ int index_args_validate(index_args_t *args, int argc, const char **argv) {
 
         args->script = malloc(info.st_size + 1);
         res = read(fd, args->script, info.st_size);
-        if (res == -1) {
+        if (res < 0) {
             fprintf(stderr, "Error reading script file '%s': %s\n", args->script_path, strerror(errno));
             return 1;
         }
@@ -189,11 +251,21 @@ int index_args_validate(index_args_t *args, int argc, const char **argv) {
         args->batch_size = DEFAULT_BATCH_SIZE;
     }
 
+    LOG_DEBUGF("cli.c", "arg es_url=%s", args->es_url)
+    LOG_DEBUGF("cli.c", "arg index_path=%s", args->index_path)
+    LOG_DEBUGF("cli.c", "arg script_path=%s", args->script_path)
+    LOG_DEBUGF("cli.c", "arg script=%s", args->script)
+    LOG_DEBUGF("cli.c", "arg print=%d", args->print)
+    LOG_DEBUGF("cli.c", "arg batch_size=%d", args->batch_size)
+    LOG_DEBUGF("cli.c", "arg force_reset=%d", args->force_reset)
+
     return 0;
 }
 
 int web_args_validate(web_args_t *args, int argc, const char **argv) {
 
+    LogCtx.verbose = 1;
+
     if (argc < 2) {
         fprintf(stderr, "Required positional argument: PATH.\n");
         return 1;
@@ -223,10 +295,21 @@ int web_args_validate(web_args_t *args, int argc, const char **argv) {
     for (int i = 0; i < args->index_count; i++) {
         char *abs_path = abspath(args->indices[i]);
         if (abs_path == NULL) {
-            fprintf(stderr, "File not found: %s\n", abs_path);
+            fprintf(stderr, "File not found: %s\n", args->indices[i]);
             return 1;
         }
     }
+
+    LOG_DEBUGF("cli.c", "arg es_url=%s", args->es_url)
+    LOG_DEBUGF("cli.c", "arg bind=%s", args->bind)
+    LOG_DEBUGF("cli.c", "arg port=%s", args->port)
+    LOG_DEBUGF("cli.c", "arg credentials=%s", args->credentials)
+    LOG_DEBUGF("cli.c", "arg b64credentials=%s", args->b64credentials)
+    LOG_DEBUGF("cli.c", "arg index_count=%d", args->index_count)
+    for (int i = 0; i < args->index_count; i++) {
+        LOG_DEBUGF("cli.c", "arg indices[%d]=%s", i, args->indices[i])
+    }
+
     return 0;
 }
 
@@ -240,5 +323,3 @@ web_args_t *web_args_create() {
     return args;
 }
 
-#endif
-

src/cli.h

@@ -16,13 +16,18 @@ typedef struct scan_args {
     char *path;
     char *archive;
     archive_mode_t archive_mode;
+    char *tesseract_lang;
+    const char *tesseract_path;
+    char *exclude_regex;
+    int fast;
 } scan_args_t;
 
 scan_args_t *scan_args_create();
+
 void scan_args_destroy(scan_args_t *args);
+
 int scan_args_validate(scan_args_t *args, int argc, const char **argv);
 
-#ifndef SIST_SCAN_ONLY
 typedef struct index_args {
     char *es_url;
     const char *index_path;
@@ -44,13 +49,15 @@ typedef struct web_args {
 } web_args_t;
 
 index_args_t *index_args_create();
+
 void index_args_destroy(index_args_t *args);
 
 web_args_t *web_args_create();
+
 void web_args_destroy(web_args_t *args);
 
 int index_args_validate(index_args_t *args, int argc, const char **argv);
+
 int web_args_validate(web_args_t *args, int argc, const char **argv);
-#endif
 
 #endif

src/ctx.h

@@ -17,6 +17,8 @@ struct {
     float tn_qscale;
     int depth;
     archive_mode_t archive_mode;
+    int verbose;
+    int very_verbose;
 
     size_t stat_tn_size;
     size_t stat_index_size;
@@ -25,10 +27,19 @@ struct {
     GHashTable *copy_table;
 
     pthread_mutex_t mupdf_mu;
+    char * tesseract_lang;
+    const char * tesseract_path;
+    pcre *exclude;
+    pcre_extra *exclude_extra;
+    int fast;
 } ScanCtx;
 
+struct {
+    int verbose;
+    int very_verbose;
+    int no_color;
+} LogCtx;
 
-#ifndef SIST_SCAN_ONLY
 struct {
     char *es_url;
     int batch_size;
@@ -40,7 +51,6 @@ struct {
     char *b64credentials;
     struct index_t indices[16];
 } WebCtx;
-#endif
 
 
 #endif

src/index/elastic.c

@@ -1,12 +1,6 @@
 #include "elastic.h"
 #include "src/ctx.h"
 
-#include <stdlib.h>
-#include "web.h"
-#include <stdio.h>
-#include <string.h>
-#include <cJSON/cJSON.h>
-
 #include "static_generated.c"
 
 
@@ -20,6 +14,8 @@ typedef struct es_indexer {
 
 static es_indexer_t *Indexer;
 
+void delete_queue(int max);
+
 void print_json(cJSON *document, const char uuid_str[UUID_STR_LEN]) {
 
     cJSON *line = cJSON_CreateObject();
@@ -27,13 +23,14 @@ void print_json(cJSON *document, const char uuid_str[UUID_STR_LEN]) {
     cJSON_AddStringToObject(line, "_id", uuid_str);
     cJSON_AddStringToObject(line, "_index", "sist2");
     cJSON_AddStringToObject(line, "_type", "_doc");
-    cJSON_AddItemToObject(line, "_source", document);
+    cJSON_AddItemReferenceToObject(line, "_source", document);
 
     char *json = cJSON_PrintUnformatted(line);
 
     printf("%s\n", json);
 
-    cJSON_free(line);
+    cJSON_free(json);
+    cJSON_Delete(line);
 }
 
 void index_json(cJSON *document, const char uuid_str[UUID_STR_LEN]) {
@@ -63,12 +60,12 @@ void execute_update_script(const char *script, const char index_id[UUID_STR_LEN]
     cJSON *term_obj = cJSON_AddObjectToObject(query, "term");
     cJSON_AddStringToObject(term_obj, "index", index_id);
 
-    char * str = cJSON_Print(body);
+    char *str = cJSON_Print(body);
 
     char bulk_url[4096];
     snprintf(bulk_url, 4096, "%s/sist2/_update_by_query?pretty", Indexer->es_url);
     response_t *r = web_post(bulk_url, str, "Content-Type: application/json");
-    printf("Executed user script <%d>\n", r->status_code);
+    LOG_INFOF("elastic.c", "Executed user script <%d>", r->status_code);
     cJSON *resp = cJSON_Parse(r->body);
 
     cJSON_free(str);
@@ -79,31 +76,25 @@ void execute_update_script(const char *script, const char index_id[UUID_STR_LEN]
     if (error != NULL) {
         char *error_str = cJSON_Print(error);
 
-        fprintf(stderr, "User script error: \n%s\n", error_str);
+        LOG_ERRORF("elastic.c", "User script error: \n%s", error_str);
         cJSON_free(error_str);
     }
 
     cJSON_Delete(resp);
 }
 
-void elastic_flush() {
-
-    if (Indexer == NULL) {
-        Indexer = create_indexer(IndexCtx.es_url);
-    }
-
+void *create_bulk_buffer(int max, int *count, size_t *buf_len) {
     es_bulk_line_t *line = Indexer->line_head;
-
-    int count = 0;
+    *count = 0;
 
     size_t buf_size = 0;
     size_t buf_cur = 0;
     char *buf = malloc(1);
 
-    while (line != NULL) {
+    while (line != NULL && *count < max) {
         char action_str[512];
         snprintf(action_str, 512,
-                "{\"index\":{\"_id\":\"%s\", \"_type\":\"_doc\", \"_index\":\"sist2\"}}\n", line->uuid_str);
+                 "{\"index\":{\"_id\":\"%s\", \"_type\":\"_doc\", \"_index\":\"sist2\"}}\n", line->uuid_str);
         size_t action_str_len = strlen(action_str);
 
         size_t line_len = strlen(line->line);
@@ -115,47 +106,105 @@ void elastic_flush() {
         memcpy(buf + buf_cur, line->line, line_len);
         buf_cur += line_len;
 
-        es_bulk_line_t *tmp = line;
         line = line->next;
-        free(tmp);
-        count++;
+        (*count)++;
     }
     buf = realloc(buf, buf_size + 1);
-    *(buf+buf_cur) = '\0';
+    *(buf + buf_cur) = '\0';
 
-    Indexer->line_head = NULL;
-    Indexer->line_tail = NULL;
-    Indexer->queued = 0;
-
-    char bulk_url[4096];
-    snprintf(bulk_url, 4096, "%s/sist2/_bulk", Indexer->es_url);
-    response_t *r = web_post(bulk_url, buf, "Content-Type: application/x-ndjson");
-
-    if (r->status_code == 0) {
-        fprintf(stderr, "Could not connect to %s, make sure that elasticsearch is running!\n", IndexCtx.es_url);
-        exit(1);
-    }
-
-    printf("Indexed %3d documents (%zukB) <%d>\n", count, buf_cur / 1024, r->status_code);
+    *buf_len = buf_cur;
+    return buf;
+}
 
+void *print_errors(response_t *r) {
     cJSON *ret_json = cJSON_Parse(r->body);
     if (cJSON_GetObjectItem(ret_json, "errors")->valueint != 0) {
         cJSON *err;
         cJSON_ArrayForEach(err, cJSON_GetObjectItem(ret_json, "items")) {
             if (cJSON_GetObjectItem(cJSON_GetObjectItem(err, "index"), "status")->valueint != 201) {
-                char* str = cJSON_Print(err);
-                fprintf(stderr, "%s\n", str);
+                char *str = cJSON_Print(err);
+                LOG_ERRORF("elastic.c", "%s\n", str);
                 cJSON_free(str);
             }
         }
     }
-
     cJSON_Delete(ret_json);
+}
+
+void _elastic_flush(int max) {
+    size_t buf_len;
+    int count;
+    void *buf = create_bulk_buffer(max, &count, &buf_len);
+
+    char bulk_url[4096];
+    snprintf(bulk_url, 4096, "%s/sist2/_bulk?pipeline=tie", Indexer->es_url);
+    response_t *r = web_post(bulk_url, buf, "Content-Type: application/x-ndjson");
+
+    if (r->status_code == 0) {
+        LOG_FATALF("elastic.c", "Could not connect to %s, make sure that elasticsearch is running!\n", IndexCtx.es_url)
+    }
+
+    if (r->status_code == 413) {
+
+        if (max <= 1) {
+            LOG_ERRORF("elastic.c", "Single document too large, giving up: {%s}", Indexer->line_head->uuid_str)
+            free_response(r);
+            free(buf);
+            delete_queue(1);
+            if (Indexer->queued != 0) {
+                elastic_flush();
+            }
+            return;
+        }
+
+        LOG_WARNINGF("elastic.c", "Payload too large, retrying (%d documents)", count);
+
+        free_response(r);
+        free(buf);
+        _elastic_flush(max / 2);
+        return;
+
+    } else if (r->status_code != 200) {
+        print_errors(r);
+        delete_queue(Indexer->queued);
+
+    } else {
+
+        print_errors(r);
+        LOG_INFOF("elastic.c", "Indexed %d documents (%zukB) <%d>", count, buf_len / 1024, r->status_code);
+        delete_queue(max);
+
+        if (Indexer->queued != 0) {
+            elastic_flush();
+        }
+    }
 
     free_response(r);
     free(buf);
 }
 
+void delete_queue(int max) {
+    for (int i = 0; i < max; i++) {
+        es_bulk_line_t *tmp = Indexer->line_head;
+        Indexer->line_head = tmp->next;
+        if (Indexer->line_head == NULL) {
+            Indexer->line_tail = NULL;
+        } else {
+            free(tmp);
+        }
+        Indexer->queued -= 1;
+    }
+}
+
+void elastic_flush() {
+
+    if (Indexer == NULL) {
+        Indexer = create_indexer(IndexCtx.es_url);
+    }
+
+    _elastic_flush(Indexer->queued);
+}
+
 void elastic_index_line(es_bulk_line_t *line) {
 
     if (Indexer == NULL) {
@@ -192,13 +241,13 @@ es_indexer_t *create_indexer(const char *url) {
     return indexer;
 }
 
-void destroy_indexer(char * script, char index_id[UUID_STR_LEN]) {
+void destroy_indexer(char *script, char index_id[UUID_STR_LEN]) {
 
     char url[4096];
 
     snprintf(url, sizeof(url), "%s/sist2/_refresh", IndexCtx.es_url);
     response_t *r = web_post(url, "", NULL);
-    printf("Refresh index <%d>\n", r->status_code);
+    LOG_INFOF("elastic.c", "Refresh index <%d>", r->status_code);
     free_response(r);
 
     if (script != NULL) {
@@ -207,12 +256,12 @@ void destroy_indexer(char * script, char index_id[UUID_STR_LEN]) {
 
     snprintf(url, sizeof(url), "%s/sist2/_refresh", IndexCtx.es_url);
     r = web_post(url, "", NULL);
-    printf("Refresh index <%d>\n", r->status_code);
+    LOG_INFOF("elastic.c", "Refresh index <%d>", r->status_code);
     free_response(r);
 
     snprintf(url, sizeof(url), "%s/sist2/_forcemerge", IndexCtx.es_url);
     r = web_post(url, "", NULL);
-    printf("Merge index <%d>\n", r->status_code);
+    LOG_INFOF("elastic.c", "Merge index <%d>", r->status_code);
     free_response(r);
 
     if (Indexer != NULL) {
@@ -232,32 +281,37 @@ void elastic_init(int force_reset) {
 
     if (!index_exists || force_reset) {
         r = web_delete(url);
-        printf("Delete index <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Delete index <%d>", r->status_code);
         free_response(r);
 
         snprintf(url, 4096, "%s/sist2", IndexCtx.es_url);
         r = web_put(url, "", NULL);
-        printf("Create index <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Create index <%d>", r->status_code);
         free_response(r);
 
         snprintf(url, 4096, "%s/sist2/_close", IndexCtx.es_url);
         r = web_post(url, "", NULL);
-        printf("Close index <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Close index <%d>", r->status_code);
+        free_response(r);
+
+        snprintf(url, 4096, "%s/_ingest/pipeline/tie", IndexCtx.es_url);
+        r = web_put(url, pipeline_json, "Content-Type: application/json");
+        LOG_INFOF("elastic.c", "Create pipeline <%d>", r->status_code);
         free_response(r);
 
         snprintf(url, 4096, "%s/sist2/_settings", IndexCtx.es_url);
         r = web_put(url, settings_json, "Content-Type: application/json");
-        printf("Update settings <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Update settings <%d>", r->status_code);
         free_response(r);
 
         snprintf(url, 4096, "%s/sist2/_mappings/_doc?include_type_name=true", IndexCtx.es_url);
         r = web_put(url, mappings_json, "Content-Type: application/json");
-        printf("Update mappings <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Update mappings <%d>", r->status_code);
         free_response(r);
 
         snprintf(url, 4096, "%s/sist2/_open", IndexCtx.es_url);
         r = web_post(url, "", NULL);
-        printf("Open index <%d>\n", r->status_code);
+        LOG_INFOF("elastic.c", "Open index <%d>", r->status_code);
         free_response(r);
     }
 }
@@ -274,3 +328,28 @@ cJSON *elastic_get_document(const char *uuid_str) {
     free_response(r);
     return json;
 }
+
+char *elastic_get_status() {
+    char url[4096];
+    snprintf(url, 4096,
+             "%s/_cluster/state/metadata/sist2?filter_path=metadata.indices.*.state", WebCtx.es_url);
+
+    response_t *r = web_get(url);
+    cJSON *json = NULL;
+    char *status = malloc(128 * sizeof(char));
+    status[0] = '\0';
+
+    if (r->status_code == 200) {
+        json = cJSON_Parse(r->body);
+        const cJSON *metadata = cJSON_GetObjectItem(json, "metadata");
+        if (metadata != NULL) {
+            const cJSON *indices = cJSON_GetObjectItem(metadata, "indices");
+            const cJSON *sist2 = cJSON_GetObjectItem(indices, "sist2");
+            const cJSON *state = cJSON_GetObjectItem(sist2, "state");
+            strcpy(status, state->valuestring);
+        }
+    }
+    free_response(r);
+    cJSON_Delete(json);
+    return status;
+}

src/index/elastic.h

@@ -30,4 +30,6 @@ void elastic_init(int force_reset);
 
 cJSON *elastic_get_document(const char *uuid_str);
 
+char *elastic_get_status();
+
 #endif

src/io/serialize.c

@@ -34,12 +34,13 @@ void write_index_descriptor(char *path, index_descriptor_t *desc) {
     cJSON_AddStringToObject(json, "version", desc->version);
     cJSON_AddStringToObject(json, "root", desc->root);
     cJSON_AddStringToObject(json, "name", desc->name);
+    cJSON_AddStringToObject(json, "type", desc->type);
     cJSON_AddStringToObject(json, "rewrite_url", desc->rewrite_url);
     cJSON_AddNumberToObject(json, "timestamp", (double) desc->timestamp);
 
     int fd = open(path, O_CREAT | O_WRONLY, S_IRUSR | S_IWUSR);
-    if (fd == -1) {
-        perror(path);
+    if (fd < 0) {
+        LOG_FATALF("serialize.c", "Could not write index descriptor: %s", strerror(errno));
     }
     char *str = cJSON_Print(json);
     write(fd, str, strlen(str));
@@ -56,8 +57,7 @@ index_descriptor_t read_index_descriptor(char *path) {
     int fd = open(path, O_RDONLY);
 
     if (fd == -1) {
-        fprintf(stderr, "Invalid/corrupt index (Could not find descriptor)\n");
-        exit(1);
+        LOG_FATALF("serialize.c", "Invalid/corrupt index (Could not find descriptor): %s: %s\n", path ,strerror(errno))
     }
 
     char *buf = malloc(info.st_size + 1);
@@ -75,6 +75,11 @@ index_descriptor_t read_index_descriptor(char *path) {
     descriptor.root_len = (short) strlen(descriptor.root);
     strcpy(descriptor.version, cJSON_GetObjectItem(json, "version")->valuestring);
     strcpy(descriptor.uuid, cJSON_GetObjectItem(json, "uuid")->valuestring);
+    if (cJSON_GetObjectItem(json, "type") == NULL) {
+        strcpy(descriptor.type, INDEX_TYPE_BIN);
+    } else {
+        strcpy(descriptor.type, cJSON_GetObjectItem(json, "type")->valuestring);
+    }
 
     cJSON_Delete(json);
     free(buf);
@@ -113,6 +118,24 @@ char *get_meta_key_text(enum metakey meta_key) {
             return "font_name";
         case MetaParent:
             return "parent";
+        case MetaExifMake:
+            return "exif_make";
+        case MetaExifSoftware:
+            return "exif_software";
+        case MetaExifExposureTime:
+            return "exif_exposure_time";
+        case MetaExifFNumber:
+            return "exif_fnumber";
+        case MetaExifFocalLength:
+            return "exif_focal_length";
+        case MetaExifUserComment:
+            return "exif_user_comment";
+        case MetaExifIsoSpeedRatings:
+            return "exif_iso_speed_ratings";
+        case MetaExifModel:
+            return "exif_model";
+        case MetaExifDateTime:
+            return "exif_datetime";
         default:
             return NULL;
     }
@@ -162,7 +185,7 @@ void write_document(document_t *doc) {
 
     int res = write(index_fd, buf.buf, buf.cur);
     if (res == -1) {
-        perror("write");
+        LOG_FATALF("serialize.c", "Could not write document: %s", strerror(errno))
     }
     ScanCtx.stat_index_size += buf.cur;
     dyn_buffer_destroy(&buf);
@@ -172,8 +195,8 @@ void thread_cleanup() {
     close(index_fd);
 }
 
-void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func func) {
 
+void read_index_bin(const char *path, const char *index_id, index_func func) {
     line_t line;
     dyn_buffer_t buf = dyn_buffer_create();
 
@@ -191,7 +214,12 @@ void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func
         char uuid_str[UUID_STR_LEN];
         uuid_unparse(line.uuid, uuid_str);
 
-        cJSON_AddStringToObject(document, "mime", mime_get_mime_text(line.mime));
+        const char* mime_text = mime_get_mime_text(line.mime);
+        if (mime_text == NULL) {
+            cJSON_AddNullToObject(document, "mime");
+        } else {
+            cJSON_AddStringToObject(document, "mime", mime_get_mime_text(line.mime));
+        }
         cJSON_AddNumberToObject(document, "size", (double) line.size);
         cJSON_AddNumberToObject(document, "mtime", line.mtime);
 
@@ -229,7 +257,7 @@ void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func
                 case MetaMediaBitrate: {
                     long value;
                     fread(&value, sizeof(long), 1, file);
-                    cJSON_AddNumberToObject(document, get_meta_key_text(key), value);
+                    cJSON_AddNumberToObject(document, get_meta_key_text(key), (double) value);
                     break;
                 }
                 case MetaMediaAudioCodec:
@@ -250,6 +278,15 @@ void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func
                 case MetaGenre:
                 case MetaFontName:
                 case MetaParent:
+                case MetaExifMake:
+                case MetaExifSoftware:
+                case MetaExifExposureTime:
+                case MetaExifFNumber:
+                case MetaExifFocalLength:
+                case MetaExifUserComment:
+                case MetaExifIsoSpeedRatings:
+                case MetaExifDateTime:
+                case MetaExifModel:
                 case MetaTitle: {
                     buf.cur = 0;
                     while ((c = getc(file)) != 0) {
@@ -262,8 +299,7 @@ void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func
                     break;
                 }
                 default:
-                    fprintf(stderr, "Invalid meta key (corrupt index): %x\n", key);
-                    break;
+                LOG_FATALF("serialize.c", "Invalid meta key (corrupt index): %x", key)
             }
 
             key = getc(file);
@@ -276,6 +312,89 @@ void read_index(const char *path, const char index_id[UUID_STR_LEN], index_func
     fclose(file);
 }
 
+const char *json_type_copy_fields[] = {
+        "mime", "name", "path", "extension", "index", "size", "mtime", "parent",
+
+        // Meta
+        "title", "content", "width", "height", "duration", "audioc", "videoc",
+        "bitrate", "artist", "album", "album_artist", "genre", "title", "font_name",
+
+        // Special
+        "tag", "_url"
+};
+
+const char *json_type_array_fields[] = {
+        "_keyword", "_text"
+};
+
+void read_index_json(const char *path, UNUSED(const char *index_id), index_func func) {
+
+    FILE *file = fopen(path, "r");
+    while (1) {
+        char *line = NULL;
+        size_t len;
+        size_t read = getline(&line, &len, file);
+        if (read < 0) {
+            if (line) {
+                free(line);
+            }
+            break;
+        }
+
+        cJSON *input = cJSON_Parse(line);
+        if (input == NULL) {
+            LOG_FATALF("serialize.c", "Could not parse JSON line: \n%s", line)
+        }
+        if (line) {
+            free(line);
+        }
+
+        cJSON *document = cJSON_CreateObject();
+        const char *uuid_str = cJSON_GetObjectItem(input, "_id")->valuestring;
+
+        for (int i = 0; i < (sizeof(json_type_copy_fields) / sizeof(json_type_copy_fields[0])); i++) {
+            cJSON *value = cJSON_GetObjectItem(input, json_type_copy_fields[i]);
+            if (value != NULL) {
+                cJSON_AddItemReferenceToObject(document, json_type_copy_fields[i], value);
+            }
+        }
+
+        for (int i = 0; i < (sizeof(json_type_array_fields) / sizeof(json_type_array_fields[0])); i++) {
+            cJSON *arr = cJSON_GetObjectItem(input, json_type_array_fields[i]);
+            if (arr != NULL) {
+                cJSON *obj;
+                cJSON_ArrayForEach(obj, arr) {
+                    char key[1024];
+                    cJSON *k = cJSON_GetObjectItem(obj, "k");
+                    cJSON *v = cJSON_GetObjectItem(obj, "v");
+                    if (k == NULL || v == NULL || !cJSON_IsString(k) || !cJSON_IsString(v)) {
+                        char *str = cJSON_Print(obj);
+                        LOG_FATALF("serialize.c", "Invalid %s member: must contain .k and .v string fields: \n%s",
+                                   json_type_array_fields[i], str)
+                    }
+                    snprintf(key, sizeof(key), "%s.%s", json_type_array_fields[i], k->valuestring);
+                    cJSON_AddStringToObject(document, key, v->valuestring);
+                }
+            }
+        }
+
+        func(document, uuid_str);
+        cJSON_Delete(document);
+        cJSON_Delete(input);
+
+    }
+    fclose(file);
+}
+
+void read_index(const char *path, const char index_id[UUID_STR_LEN], const char *type, index_func func) {
+
+    if (strcmp(type, INDEX_TYPE_BIN) == 0) {
+        read_index_bin(path, index_id, func);
+    } else if (strcmp(type, INDEX_TYPE_JSON) == 0) {
+        read_index_json(path, index_id, func);
+    }
+}
+
 void incremental_read(GHashTable *table, const char *filepath) {
     FILE *file = fopen(filepath, "rb");
     line_t line;

src/io/serialize.h

@@ -11,7 +11,7 @@ void incremental_copy(store_t *store, store_t *dst_store, const char *filepath,
 
 void write_document(document_t *doc);
 
-void read_index(const char *path, const char[UUID_STR_LEN], index_func);
+void read_index(const char *path, const char[UUID_STR_LEN], const char *type, index_func);
 
 void incremental_read(GHashTable *table, const char *filepath);
 

src/io/store.c

@@ -9,14 +9,13 @@ store_t *store_create(char *path) {
     mdb_env_create(&store->env);
 
     int open_ret = mdb_env_open(store->env,
-                 path,
-                 MDB_WRITEMAP | MDB_MAPASYNC,
-                 S_IRUSR | S_IWUSR
+                                path,
+                                MDB_WRITEMAP | MDB_MAPASYNC,
+                                S_IRUSR | S_IWUSR
     );
 
     if (open_ret != 0) {
-        fprintf(stderr, "Error while opening store: %s (%s)\n", mdb_strerror(open_ret), path);
-        exit(1);
+        LOG_FATALF("store.c", "Error while opening store: %s (%s)\n", mdb_strerror(open_ret), path)
     }
 
     store->size = (size_t) 1024 * 1024 * 5;
@@ -42,6 +41,12 @@ void store_destroy(store_t *store) {
 
 void store_write(store_t *store, char *key, size_t key_len, char *buf, size_t buf_len) {
 
+    if (LogCtx.very_verbose) {
+        char uuid_str[UUID_STR_LEN];
+        uuid_unparse((unsigned char *) key, uuid_str);
+        LOG_DEBUGF("store.c", "Store write {%s} %lu bytes", uuid_str, buf_len)
+    }
+
     MDB_val mdb_key;
     mdb_key.mv_data = key;
     mdb_key.mv_size = key_len;
@@ -68,13 +73,15 @@ void store_write(store_t *store, char *key, size_t key_len, char *buf, size_t bu
         mdb_env_set_mapsize(store->env, store->size);
         mdb_txn_begin(store->env, NULL, 0, &txn);
         put_ret = mdb_put(txn, store->dbi, &mdb_key, &mdb_value, 0);
+
+        LOG_INFOF("store.c", "Updated mdb mapsize to %lu bytes", store->size)
     }
 
     mdb_txn_commit(txn);
     pthread_rwlock_unlock(&store->lock);
 
     if (put_ret != 0) {
-        printf("%s\n", mdb_strerror(put_ret));
+        LOG_ERROR("store.c", mdb_strerror(put_ret))
     }
 }
 

src/io/walk.c

@@ -28,8 +28,18 @@ parse_job_t *create_fs_parse_job(const char *filepath, const struct stat *info,
     return job;
 }
 
+int sub_strings[30];
+#define EXCLUDED(str) (pcre_exec(ScanCtx.exclude, ScanCtx.exclude_extra, filepath, strlen(filepath), 0, 0, sub_strings, sizeof(sub_strings)) >= 0)
+
 int handle_entry(const char *filepath, const struct stat *info, int typeflag, struct FTW *ftw) {
-    if (ftw->level <= ScanCtx.depth && typeflag == FTW_F && S_ISREG(info->st_mode)) {
+
+    if (typeflag == FTW_F && S_ISREG(info->st_mode) && ftw->level <= ScanCtx.depth) {
+
+        if (ScanCtx.exclude != NULL && EXCLUDED(filepath)) {
+            LOG_DEBUGF("walk.c", "Excluded: %s", filepath)
+            return 0;
+        }
+
         parse_job_t *job = create_fs_parse_job(filepath, info, ftw->base);
         tpool_add_work(ScanCtx.pool, parse, job);
     }

src/log.c

@@ -0,0 +1,99 @@
+#include "log.h"
+
+const char *log_colors[] = {
+        "\033[34m", "\033[01;34m", "\033[0m",
+        "\033[01;33m", "\033[31m", "\033[01;31m"
+};
+
+const char *log_levels[] = {
+        "DEBUG", "INFO", "WARNING", "ERROR", "FATAL"
+};
+
+void sist_logf(char *filepath, int level, char *format, ...) {
+
+    static int is_tty = -1;
+    if (is_tty == -1) {
+        is_tty = isatty(STDERR_FILENO);
+    }
+
+    char log_str[LOG_MAX_LENGTH];
+
+    unsigned long long pid = (unsigned long long) pthread_self();
+
+    char datetime[32];
+    time_t t;
+    struct tm result;
+    t = time(NULL);
+    localtime_r(&t, &result);
+    strftime(datetime, sizeof(datetime), "%Y-%m-%d %H:%M:%S", &result);
+
+    int log_len;
+    if (is_tty) {
+        log_len = snprintf(
+                log_str, sizeof(log_str),
+                "\033[%dm[%04X]%s [%s] [%s %s] ",
+                31 + ((unsigned int) (pid)) % 7, pid, log_colors[level],
+                datetime, log_levels[level], filepath
+        );
+    } else {
+        log_len = snprintf(
+                log_str, sizeof(log_str),
+                "[%04X] [%s] [%s %s] ",
+                pid, datetime, log_levels[level], filepath
+        );
+    }
+
+    va_list ap;
+    va_start(ap, format);
+    size_t maxsize = sizeof(log_str) - log_len;
+    log_len += vsnprintf(log_str + log_len, maxsize, format, ap);
+    va_end(ap);
+
+    if (is_tty) {
+        log_len += sprintf(log_str + log_len, "\033[0m\n");
+    } else {
+        *(log_str + log_len) = '\n';
+        log_len += 1;
+    }
+
+    write(STDERR_FILENO, log_str, log_len);
+}
+
+void sist_log(char *filepath, int level, char *str) {
+
+    static int is_tty = -1;
+    if (is_tty == -1) {
+        is_tty = isatty(STDERR_FILENO);
+    }
+
+    char log_str[LOG_MAX_LENGTH];
+
+    unsigned long long pid = (unsigned long long) pthread_self();
+
+    char datetime[32];
+    time_t t;
+    struct tm result;
+    t = time(NULL);
+    localtime_r(&t, &result);
+    strftime(datetime, sizeof(datetime), "%Y-%m-%d %H:%M:%S", &result);
+
+    int log_len;
+    if (is_tty) {
+        log_len = snprintf(
+                log_str, sizeof(log_str),
+                "\033[%dm[%04X]%s [%s] [%s %s] %s \033[0m\n",
+                31 + ((unsigned int) (pid)) % 7, pid, log_colors[level],
+                datetime, log_levels[level], filepath,
+                str
+        );
+    } else {
+        log_len = snprintf(
+                log_str, sizeof(log_str),
+                "[%04X] [%s] [%s %s] %s \n",
+                pid, datetime, log_levels[level], filepath,
+                str
+        );
+    }
+
+    write(STDERR_FILENO, log_str, log_len);
+}

src/log.h

@@ -0,0 +1,45 @@
+#ifndef SIST2_LOG_H
+#define SIST2_LOG_H
+
+#define LOG_MAX_LENGTH 8192
+
+#define SIST_DEBUG 0
+#define SIST_INFO 1
+#define SIST_WARNING 2
+#define SIST_ERROR 3
+#define SIST_FATAL 4
+
+#define LOG_DEBUGF(filepath, fmt, ...) \
+    if (LogCtx.very_verbose) {sist_logf(filepath, SIST_DEBUG, fmt, __VA_ARGS__);}
+#define LOG_DEBUG(filepath, str) \
+    if (LogCtx.very_verbose) {sist_log(filepath, SIST_DEBUG, str);}
+
+#define LOG_INFOF(filepath, fmt, ...) \
+    if (LogCtx.verbose) {sist_logf(filepath, SIST_INFO, fmt, __VA_ARGS__);}
+#define LOG_INFO(filepath, str) \
+    if (LogCtx.verbose) {sist_log(filepath, SIST_INFO, str);}
+
+#define LOG_WARNINGF(filepath, fmt, ...) \
+    if (LogCtx.verbose) {sist_logf(filepath, SIST_WARNING, fmt, __VA_ARGS__);}
+#define LOG_WARNING(filepath, str) \
+    if (LogCtx.verbose) {sist_log(filepath, SIST_WARNING, str);}
+
+#define LOG_ERRORF(filepath, fmt, ...) \
+    if (LogCtx.verbose) {sist_logf(filepath, SIST_ERROR, fmt, __VA_ARGS__);}
+#define LOG_ERROR(filepath, str) \
+    if (LogCtx.verbose) {sist_log(filepath, SIST_ERROR, str);}
+
+#define LOG_FATALF(filepath, fmt, ...) \
+    sist_logf(filepath, SIST_FATAL, fmt, __VA_ARGS__);\
+    exit(-1);
+#define LOG_FATAL(filepath, str) \
+    sist_log(filepath, SIST_FATAL, str);\
+    exit(-1);
+
+#include "src/sist.h"
+
+void sist_logf(char *filepath, int level, char *format, ...);
+
+void sist_log(char *filepath, int level, char *str);
+
+#endif

src/main.c

@@ -1,16 +1,12 @@
 #include "sist.h"
 #include "ctx.h"
 
-#ifndef SIST_SCAN_ONLY
 #define DESCRIPTION "Lightning-fast file system indexer and search tool."
-#else
-#define DESCRIPTION "Lightning-fast file system indexer and search tool. (SCAN ONLY)"
-#endif
 
 #define EPILOG "Made by simon987 <me@simon987.net>. Released under GPL-3.0"
 
 
-static const char *const Version = "1.1.11";
+static const char *const Version = "1.3.1";
 static const char *const usage[] = {
         "sist2 scan [OPTION]... PATH",
         "sist2 index [OPTION]... INDEX",
@@ -19,11 +15,8 @@ static const char *const usage[] = {
 };
 
 void global_init() {
-#ifndef SIST_SCAN_ONLY
     curl_global_init(CURL_GLOBAL_NOTHING);
-#endif
     av_log_set_level(AV_LOG_QUIET);
-    opcInitLibrary();
 }
 
 void init_dir(const char *dirpath) {
@@ -35,29 +28,13 @@ void init_dir(const char *dirpath) {
     uuid_unparse(uuid, ScanCtx.index.desc.uuid);
     time(&ScanCtx.index.desc.timestamp);
     strcpy(ScanCtx.index.desc.version, Version);
+    strcpy(ScanCtx.index.desc.type, INDEX_TYPE_BIN);
 
     write_index_descriptor(path, &ScanCtx.index.desc);
 }
 
 void scan_print_header() {
-    printf("sist2 V%s\n", Version);
-    printf("---------------------\n");
-    printf("threads\t\t\t%d\n", ScanCtx.threads);
-    printf("tn_qscale\t\t%.1f/31.0\n", ScanCtx.tn_qscale);
-
-    if (ScanCtx.tn_size > 0) {
-        printf("tn_size\t\t\t%dpx\n", ScanCtx.tn_size);
-    } else {
-        printf("tn_size\t\t\tdisabled\n");
-    }
-
-    if (ScanCtx.content_size > 0) {
-        printf("content_size\t\t%d B\n", ScanCtx.content_size);
-    } else {
-        printf("content_size\t\t\tdisabled\n");
-    }
-
-    printf("output\t\t\t%s\n", ScanCtx.index.path);
+    LOG_INFOF("main.c", "sist2 v%s", Version)
 }
 
 void sist2_scan(scan_args_t *args) {
@@ -71,13 +48,19 @@ void sist2_scan(scan_args_t *args) {
     strncpy(ScanCtx.index.path, args->output, sizeof(ScanCtx.index.path));
     strncpy(ScanCtx.index.desc.name, args->name, sizeof(ScanCtx.index.desc.name));
     strncpy(ScanCtx.index.desc.root, args->path, sizeof(ScanCtx.index.desc.root));
+    strncpy(ScanCtx.index.desc.rewrite_url, args->rewrite_url, sizeof(ScanCtx.index.desc.rewrite_url));
     ScanCtx.index.desc.root_len = (short) strlen(ScanCtx.index.desc.root);
+    ScanCtx.tesseract_lang = args->tesseract_lang;
+    ScanCtx.tesseract_path = args->tesseract_path;
+    ScanCtx.fast = args->fast;
 
     init_dir(ScanCtx.index.path);
 
     ScanCtx.mime_table = mime_get_mime_table();
     ScanCtx.ext_table = mime_get_ext_table();
 
+    cbr_init();
+
     char store_path[PATH_MAX];
     snprintf(store_path, PATH_MAX, "%sthumbs", ScanCtx.index.path);
     mkdir(store_path, S_IWUSR | S_IRUSR | S_IXUSR);
@@ -91,9 +74,18 @@ void sist2_scan(scan_args_t *args) {
 
         DIR *dir = opendir(args->incremental);
         if (dir == NULL) {
-            perror("opendir");
-            return;
+            LOG_FATALF("main.c", "Could not open original index for incremental scan: %s", strerror(errno))
         }
+
+        char descriptor_path[PATH_MAX];
+        snprintf(descriptor_path, PATH_MAX, "%s/descriptor.json", args->incremental);
+        index_descriptor_t original_desc = read_index_descriptor(descriptor_path);
+
+        if (strcmp(original_desc.version, Version) != 0) {
+            LOG_FATALF("main.c", "Version mismatch! Index is %s but executable is %s/%s", original_desc.version,
+                       Version, INDEX_VERSION_EXTERNAL)
+        }
+
         struct dirent *de;
         while ((de = readdir(dir)) != NULL) {
             if (strncmp(de->d_name, "_index_", sizeof("_index_") - 1) == 0) {
@@ -104,7 +96,7 @@ void sist2_scan(scan_args_t *args) {
         }
         closedir(dir);
 
-        printf("Loaded %d items in to mtime table.", g_hash_table_size(ScanCtx.original_table));
+        LOG_INFOF("main.c", "Loaded %d items in to mtime table.", g_hash_table_size(ScanCtx.original_table))
     }
 
     ScanCtx.pool = tpool_create(args->threads, thread_cleanup);
@@ -139,8 +131,6 @@ void sist2_scan(scan_args_t *args) {
     store_destroy(ScanCtx.index.store);
 }
 
-#ifndef SIST_SCAN_ONLY
-
 void sist2_index(index_args_t *args) {
 
     IndexCtx.es_url = args->es_url;
@@ -154,15 +144,17 @@ void sist2_index(index_args_t *args) {
     snprintf(descriptor_path, PATH_MAX, "%s/descriptor.json", args->index_path);
 
     index_descriptor_t desc = read_index_descriptor(descriptor_path);
-    if (strcmp(desc.version, Version) != 0) {
-        fprintf(stderr, "Version mismatch! Index is v%s but executable is v%s\n", desc.version, Version);
-        return;
+
+    LOG_DEBUGF("main.c", "descriptor version %s (%s)", desc.version, desc.type)
+
+    if (strcmp(desc.version, Version) != 0 && strcmp(desc.version, INDEX_VERSION_EXTERNAL) != 0) {
+        LOG_FATALF("main.c", "Version mismatch! Index is %s but executable is %s/%s", desc.version, Version,
+                   INDEX_VERSION_EXTERNAL)
     }
 
     DIR *dir = opendir(args->index_path);
     if (dir == NULL) {
-        perror("opendir");
-        return;
+        LOG_FATALF("main.c", "Could not open index %s: %s", args->index_path, strerror(errno))
     }
 
     index_func f;
@@ -177,7 +169,7 @@ void sist2_index(index_args_t *args) {
         if (strncmp(de->d_name, "_index_", sizeof("_index_") - 1) == 0) {
             char file_path[PATH_MAX];
             snprintf(file_path, PATH_MAX, "%s/%s", args->index_path, de->d_name);
-            read_index(file_path, desc.uuid, f);
+            read_index(file_path, desc.uuid, desc.type, f);
         }
     }
     closedir(dir);
@@ -215,18 +207,14 @@ void sist2_web(web_args_t *args) {
     serve(args->bind, args->port);
 }
 
-#endif
-
 
 int main(int argc, const char *argv[]) {
 
     global_init();
 
     scan_args_t *scan_args = scan_args_create();
-#ifndef SIST_SCAN_ONLY
     index_args_t *index_args = index_args_create();
     web_args_t *web_args = web_args_create();
-#endif
 
     int arg_version = 0;
 
@@ -236,6 +224,8 @@ int main(int argc, const char *argv[]) {
             OPT_HELP(),
 
             OPT_BOOLEAN('v', "version", &arg_version, "Show version and exit"),
+            OPT_BOOLEAN(0, "verbose", &LogCtx.verbose, "Turn on logging"),
+            OPT_BOOLEAN(0, "very-verbose", &LogCtx.very_verbose, "Turn on debug messages"),
 
             OPT_GROUP("Scan options"),
             OPT_INTEGER('t', "threads", &scan_args->threads, "Number of threads. DEFAULT=1"),
@@ -255,8 +245,11 @@ int main(int argc, const char *argv[]) {
             OPT_STRING(0, "archive", &scan_args->archive, "Archive file mode (skip|list|shallow|recurse). "
                                                           "skip: Don't parse, list: only get file names as text, "
                                                           "shallow: Don't parse archives inside archives. DEFAULT: recurse"),
+            OPT_STRING(0, "ocr", &scan_args->tesseract_lang, "Tesseract language (use tesseract --list-langs to see "
+                                                             "which are installed on your machine)"),
+            OPT_STRING('e', "exclude", &scan_args->exclude_regex, "Files that match this regex will not be scanned"),
+            OPT_BOOLEAN(0, "fast", &scan_args->fast, "Only index file names & mime type"),
 
-#ifndef SIST_SCAN_ONLY
             OPT_GROUP("Index options"),
             OPT_STRING(0, "es-url", &common_es_url, "Elasticsearch url with port. DEFAULT=http://localhost:9200"),
             OPT_BOOLEAN('p', "print", &index_args->print, "Just print JSON documents to stdout."),
@@ -270,7 +263,6 @@ int main(int argc, const char *argv[]) {
             OPT_STRING(0, "bind", &web_args->bind, "Listen on this address. DEFAULT=localhost"),
             OPT_STRING(0, "port", &web_args->port, "Listen on this port. DEFAULT=4090"),
             OPT_STRING(0, "auth", &web_args->credentials, "Basic auth in user:password format"),
-#endif
 
             OPT_END(),
     };
@@ -282,33 +274,32 @@ int main(int argc, const char *argv[]) {
 
     if (arg_version) {
         printf(Version);
-        exit(0);
+        goto end;
+    }
+
+    if (LogCtx.very_verbose != 0) {
+        LogCtx.verbose = 1;
     }
 
-#ifndef SIST_SCAN_ONLY
     web_args->es_url = common_es_url;
     index_args->es_url = common_es_url;
-#endif
 
     if (argc == 0) {
         argparse_usage(&argparse);
-        return 1;
+        goto end;
     } else if (strcmp(argv[0], "scan") == 0) {
 
         int err = scan_args_validate(scan_args, argc, argv);
         if (err != 0) {
-            return err;
+            goto end;
         }
         sist2_scan(scan_args);
 
-    }
-
-#ifndef SIST_SCAN_ONLY
-    else if (strcmp(argv[0], "index") == 0) {
+    } else if (strcmp(argv[0], "index") == 0) {
 
         int err = index_args_validate(index_args, argc, argv);
         if (err != 0) {
-            return err;
+            goto end;
         }
         sist2_index(index_args);
 
@@ -316,25 +307,21 @@ int main(int argc, const char *argv[]) {
 
         int err = web_args_validate(web_args, argc, argv);
         if (err != 0) {
-            return err;
+            goto end;
         }
         sist2_web(web_args);
 
-    }
-#endif
-    else {
+    } else {
         fprintf(stderr, "Invalid command: '%s'\n", argv[0]);
         argparse_usage(&argparse);
-        return 1;
+        goto end;
     }
     printf("\n");
 
+    end:
     scan_args_destroy(scan_args);
-
-#ifndef SIST_SCAN_ONLY
     index_args_destroy(index_args);
     web_args_destroy(web_args);
-#endif
 
     return 0;
 }

src/parsing/arc.c

@@ -1,8 +1,6 @@
 #include "arc.h"
 #include "src/ctx.h"
 
-#define ARC_BUF_SIZE 8192
-
 int should_parse_filtered_file(const char *filepath, int ext) {
     char tmp[PATH_MAX * 2];
 
@@ -67,18 +65,24 @@ void parse_archive(vfile_t *f, document_t *doc) {
     struct archive *a;
     struct archive_entry *entry;
 
-    a = archive_read_new();
-
-    archive_read_support_filter_all(a);
-    archive_read_support_format_all(a);
 
     arc_data_f data;
     data.f = f;
 
     int ret = 0;
     if (data.f->is_fs_file) {
+
+        a = archive_read_new();
+        archive_read_support_filter_all(a);
+        archive_read_support_format_all(a);
+
         ret = archive_read_open_filename(a, doc->filepath, ARC_BUF_SIZE);
     } else if (ScanCtx.archive_mode == ARC_MODE_RECURSE) {
+
+        a = archive_read_new();
+        archive_read_support_filter_all(a);
+        archive_read_support_format_all(a);
+
         ret = archive_read_open(
                 a, &data,
                 vfile_open_callback,
@@ -86,12 +90,11 @@ void parse_archive(vfile_t *f, document_t *doc) {
                 vfile_close_callback
         );
     } else {
-        archive_read_free(a);
         return;
     }
 
     if (ret != ARCHIVE_OK) {
-        fprintf(stderr, "OPEN[%d]:%s %s\n", ret, archive_error_string(a), doc->filepath);
+        LOG_ERRORF(doc->filepath, "(arc.c) [%d] %s", ret, archive_error_string(a))
         archive_read_free(a);
         return;
     }

src/parsing/arc.h

@@ -2,6 +2,7 @@
 #define SIST2_ARC_H
 
 #include "src/sist.h"
+#define ARC_BUF_SIZE 8192
 
 int should_parse_filtered_file(const char *filepath, int ext);
 

src/parsing/cbr.c

@@ -0,0 +1,52 @@
+#include "cbr.h"
+#include "src/ctx.h"
+
+unsigned int cbr_mime;
+unsigned int cbz_mime;
+
+void cbr_init() {
+    cbr_mime = mime_get_mime_by_string(ScanCtx.mime_table, "application/x-cbr");
+    cbz_mime = mime_get_mime_by_string(ScanCtx.mime_table, "application/x-cbz");
+}
+
+int is_cbr(unsigned int mime) {
+    return mime == cbr_mime;
+}
+
+void parse_cbr(void *buf, size_t buf_len, document_t *doc) {
+    char *out_buf = malloc(buf_len * 2);
+    size_t out_buf_used = 0;
+
+    struct archive *rar_in = archive_read_new();
+    archive_read_support_filter_none(rar_in);
+    archive_read_support_format_rar(rar_in);
+
+    archive_read_open_memory(rar_in, buf, buf_len);
+
+    struct archive *zip_out = archive_write_new();
+    archive_write_set_format_zip(zip_out);
+    archive_write_open_memory(zip_out, out_buf, buf_len * 2, &out_buf_used);
+
+    struct archive_entry *entry;
+    while (archive_read_next_header(rar_in, &entry) == ARCHIVE_OK) {
+        archive_write_header(zip_out, entry);
+
+        char arc_buf[ARC_BUF_SIZE];
+        int len = archive_read_data(rar_in, arc_buf, ARC_BUF_SIZE);
+        while (len > 0) {
+            archive_write_data(zip_out, arc_buf, len);
+            len = archive_read_data(rar_in, arc_buf, ARC_BUF_SIZE);
+        }
+    }
+
+    archive_write_close(zip_out);
+    archive_write_free(zip_out);
+
+    archive_read_close(rar_in);
+    archive_read_free(rar_in);
+
+    doc->mime = cbz_mime;
+    parse_pdf(out_buf, out_buf_used, doc);
+    doc->mime = cbr_mime;
+    free(out_buf);
+}

src/parsing/cbr.h

@@ -0,0 +1,12 @@
+#ifndef SIST2_CBR_H
+#define SIST2_CBR_H
+
+#include "src/sist.h"
+
+void cbr_init();
+
+int is_cbr(unsigned int mime);
+
+void parse_cbr(void *buf, size_t buf_len, document_t *doc);
+
+#endif

src/parsing/doc.c

@@ -1,48 +1,31 @@
 #include "doc.h"
+#include "src/ctx.h"
 
-static void dumpText(mceTextReader_t *reader, dyn_buffer_t *buf) {
 
-    mce_skip_attributes(reader);
-
-    mce_start_children(reader) {
-        mce_start_element(reader, NULL, _X("t")) {
-            mce_skip_attributes(reader);
-            mce_start_children(reader) {
-                mce_start_text(reader) {
-                    char *str = (char *) xmlTextReaderConstValue(reader->reader);
-                    dyn_buffer_append_string(buf, str);
-                    dyn_buffer_write_char(buf, ' ');
-                } mce_end_text(reader);
-            } mce_end_children(reader);
-        } mce_end_element(reader);
-
-        mce_start_element(reader, NULL, NULL) {
-            dumpText(reader, buf);
-        } mce_end_element(reader);
-
-    } mce_end_children(reader)
-}
+#define STR_STARTS_WITH(x, y) (strncmp(y, x, sizeof(y) - 1) == 0)
 
 __always_inline
-int should_read_part(opcPart part) {
+static int should_read_part(const char *part) {
 
-    char *part_name = (char *) part;
+    LOG_DEBUGF("doc.c", "Got part : %s", part)
 
     if (part == NULL) {
         return FALSE;
     }
 
     if (    // Word
-            strcmp(part_name, "word/document.xml") == 0
-            || strncmp(part_name, "word/footer", sizeof("word/footer") - 1) == 0
-            || strncmp(part_name, "word/header", sizeof("word/header") - 1) == 0
+            STR_STARTS_WITH(part, "word/document.xml")
+            || STR_STARTS_WITH(part, "word/footnotes.xml")
+            || STR_STARTS_WITH(part, "word/endnotes.xml")
+            || STR_STARTS_WITH(part, "word/footer")
+            || STR_STARTS_WITH(part, "word/header")
             // PowerPoint
-            || strncmp(part_name, "ppt/slides/slide", sizeof("ppt/slides/slide") - 1) == 0
-            || strncmp(part_name, "ppt/notesSlides/notesSlide", sizeof("ppt/notesSlides/notesSlide") - 1) == 0
+            || STR_STARTS_WITH(part, "ppt/slides/slide")
+            || STR_STARTS_WITH(part, "ppt/notesSlides/slide")
             // Excel
-            || strncmp(part_name, "xl/worksheets/sheet", sizeof("xl/worksheets/sheet") - 1) == 0
-            || strcmp(part_name, "xl/sharedStrings.xml") == 0
-            || strcmp(part_name, "xl/workbook.xml") == 0
+            || STR_STARTS_WITH(part, "xl/worksheets/sheet")
+            || STR_STARTS_WITH(part, "xl/sharedStrings.xml")
+            || STR_STARTS_WITH(part, "xl/workbook.xml")
             ) {
         return TRUE;
     }
@@ -50,49 +33,108 @@ int should_read_part(opcPart part) {
     return FALSE;
 }
 
-void read_part(opcContainer *c, dyn_buffer_t *buf, opcPart part) {
-
-    mceTextReader_t reader;
-    int ret = opcXmlReaderOpen(c, &reader, part, NULL, "UTF-8", 0);
-
-    if (ret != OPC_ERROR_NONE) {
-        //todo verbose
-        return;
+int extract_text(xmlDoc *xml, xmlNode *node, text_buffer_t *buf) {
+    //TODO: Check which nodes are likely to have a 't' child, and ignore nodes that aren't
+    xmlErrorPtr err = xmlGetLastError();
+    if (err != NULL) {
+        if (err->level == XML_ERR_FATAL) {
+            LOG_ERRORF("doc.c", "Got fatal XML error while parsing document: %s", err->message)
+            return -1;
+        } else {
+            LOG_ERRORF("doc.c", "Got recoverable XML error while parsing document: %s", err->message)
+        }
     }
 
-    mce_start_document(&reader) {
-        mce_start_element(&reader, NULL, NULL) {
-            dumpText(&reader, buf);
-        } mce_end_element(&reader);
-    }mce_end_document(&reader);
+    for (xmlNode *child = node; child; child = child->next) {
+        if (*child->name == 't' && *(child->name + 1) == '\0') {
+            xmlChar *text = xmlNodeListGetString(xml, child->xmlChildrenNode, 1);
 
-    mceTextReaderCleanup(&reader);
+            if (text) {
+                text_buffer_append_string0(buf, (char *) text);
+                text_buffer_append_char(buf, ' ');
+                xmlFree(text);
+            }
+        }
+
+        extract_text(xml, child->children, buf);
+    }
+}
+
+int xml_io_read(void *context, char *buffer, int len) {
+    struct archive *a = context;
+    return archive_read_data(a, buffer, len);
+}
+
+int xml_io_close(UNUSED(void *context)) {
+    //noop
+    return 0;
+}
+
+__always_inline
+static int read_part(struct archive *a, text_buffer_t *buf, document_t *doc) {
+
+    xmlDoc *xml = xmlReadIO(xml_io_read, xml_io_close, a, "/", NULL, XML_PARSE_RECOVER | XML_PARSE_NOWARNING | XML_PARSE_NOERROR | XML_PARSE_NONET);
+
+    if (xml == NULL) {
+        LOG_ERROR(doc->filepath, "Could not parse XML")
+        return -1;
+    }
+
+    xmlNode *root = xmlDocGetRootElement(xml);
+    if (root == NULL) {
+        LOG_ERROR(doc->filepath, "Empty document")
+        xmlFreeDoc(xml);
+        return -1;
+    }
+
+    extract_text(xml, root, buf);
+    xmlFreeDoc(xml);
+
+    return 0;
 }
 
 void parse_doc(void *mem, size_t mem_len, document_t *doc) {
 
-    opcContainer *c = opcContainerOpenMem(mem, mem_len, OPC_OPEN_READ_ONLY, NULL);
-    if (c == NULL) {
-        //todo verbose
+    if (mem == NULL) {
         return;
     }
 
-    dyn_buffer_t buf = dyn_buffer_create();
+    struct archive *a = archive_read_new();
+    archive_read_support_format_zip(a);
 
-    opcPart part = opcPartGetFirst(c);
-    do {
-        if (should_read_part(part)) {
-            read_part(c, &buf, part);
+    int ret = archive_read_open_memory(a, mem, mem_len);
+    if (ret != ARCHIVE_OK) {
+        LOG_ERRORF(doc->filepath, "Could not read archive: %s", archive_error_string(a))
+        archive_read_free(a);
+        return;
+    }
+
+    text_buffer_t buf = text_buffer_create(ScanCtx.content_size);
+
+    struct archive_entry *entry;
+    while (archive_read_next_header(a, &entry) == ARCHIVE_OK) {
+        if (S_ISREG(archive_entry_stat(entry)->st_mode)) {
+            const char *path = archive_entry_pathname(entry);
+
+            if (should_read_part(path)) {
+                ret = read_part(a, &buf, doc);
+                if (ret != 0) {
+                    break;
+                }
+            }
         }
-    } while ((part = opcPartGetNext(c, part)));
+    }
 
-    opcContainerClose(c, OPC_CLOSE_NOW);
-    dyn_buffer_write_char(&buf, '\0');
+    if (buf.dyn_buffer.cur > 0) {
+        text_buffer_terminate_string(&buf);
 
-    meta_line_t *meta = malloc(sizeof(meta_line_t) + buf.cur);
-    meta->key = MetaContent;
-    strcpy(meta->strval, buf.buf);
-    APPEND_META(doc, meta)
+        meta_line_t *meta = malloc(sizeof(meta_line_t) + buf.dyn_buffer.cur);
+        meta->key = MetaContent;
+        strcpy(meta->strval, buf.dyn_buffer.buf);
+        APPEND_META(doc, meta)
+    }
 
-    dyn_buffer_destroy(&buf);
+    archive_read_close(a);
+    archive_read_free(a);
+    text_buffer_destroy(&buf);
 }

src/parsing/font.c

@@ -147,6 +147,7 @@ void parse_font(const char *buf, size_t buf_len, document_t *doc) {
     FT_Face face;
     FT_Error err = FT_New_Memory_Face(ft_lib, (unsigned char *) buf, buf_len, 0, &face);
     if (err != 0) {
+        LOG_ERRORF(doc->filepath, "(font.c) FT_New_Memory_Face() returned error code [%d] %s", err, ft_error_string(err));
         return;
     }
 
@@ -176,6 +177,7 @@ void parse_font(const char *buf, size_t buf_len, document_t *doc) {
 
     err = FT_Set_Pixel_Sizes(face, 0, pixel);
     if (err != 0) {
+        LOG_WARNINGF(doc->filepath, "(font.c) FT_Set_Pixel_Sizes() returned error code [%d] %s", err, ft_error_string(err))
         return;
     }
 
@@ -194,6 +196,7 @@ void parse_font(const char *buf, size_t buf_len, document_t *doc) {
             c = c >= 'a' && c <= 'z' ? c - 32 : c + 32;
             err = FT_Load_Char(face, c, FT_LOAD_NO_HINTING | FT_LOAD_RENDER);
             if (err != 0) {
+                LOG_WARNINGF(doc->filepath, "(font.c) FT_Load_Char() returned error code [%d] %s", err, ft_error_string(err));
                 continue;
             }
         }

src/parsing/media.c

@@ -5,7 +5,7 @@
 #define AVIO_BUF_SIZE 8192
 
 __always_inline
-AVCodecContext *alloc_jpeg_encoder(int dstW, int dstH, float qscale) {
+static AVCodecContext *alloc_jpeg_encoder(int dstW, int dstH, float qscale) {
 
     AVCodec *jpeg_codec = avcodec_find_encoder(AV_CODEC_ID_MJPEG);
     AVCodecContext *jpeg = avcodec_alloc_context3(jpeg_codec);
@@ -77,7 +77,8 @@ AVFrame *scale_frame(const AVCodecContext *decoder, const AVFrame *frame, int si
     return scaled_frame;
 }
 
-AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int stream_idx) {
+__always_inline
+static AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int stream_idx, document_t *doc) {
     AVFrame *frame = av_frame_alloc();
 
     AVPacket avPacket;
@@ -90,9 +91,12 @@ AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int st
             int read_frame_ret = av_read_frame(pFormatCtx, &avPacket);
 
             if (read_frame_ret != 0) {
-//                if (read_frame_ret != AVERROR_EOF) {
-//                    fprintf(stderr, "Error reading frame: %d\n", read_frame_ret);
-//                }
+                if (read_frame_ret != AVERROR_EOF) {
+                    LOG_WARNINGF(doc->filepath,
+                                 "(media.c) avcodec_read_frame() returned error code [%d] %s",
+                                 read_frame_ret, av_err2str(read_frame_ret)
+                    )
+                }
                 av_frame_free(&frame);
                 av_packet_unref(&avPacket);
                 return NULL;
@@ -109,7 +113,10 @@ AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int st
         // Feed it to decoder
         int decode_ret = avcodec_send_packet(decoder, &avPacket);
         if (decode_ret != 0) {
-            printf("Error decoding frame: %s\n", av_err2str(decode_ret));
+            LOG_WARNINGF(doc->filepath,
+                         "(media.c) avcodec_send_packet() returned error code [%d] %s",
+                         decode_ret, av_err2str(decode_ret)
+            )
         }
         av_packet_unref(&avPacket);
         receive_ret = avcodec_receive_frame(decoder, frame);
@@ -120,6 +127,7 @@ AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int st
 #define APPEND_TAG_META(doc, tag_, keyname) \
     text_buffer_t tex = text_buffer_create(-1); \
     text_buffer_append_string0(&tex, tag_->value); \
+    text_buffer_terminate_string(&tex); \
     meta_line_t *meta_tag = malloc(sizeof(meta_line_t) + tex.dyn_buffer.cur); \
     meta_tag->key = keyname; \
     strcpy(meta_tag->strval, tex.dyn_buffer.buf); \
@@ -127,7 +135,7 @@ AVFrame *read_frame(AVFormatContext *pFormatCtx, AVCodecContext *decoder, int st
     text_buffer_destroy(&tex);
 
 __always_inline
-void append_audio_meta(AVFormatContext *pFormatCtx, document_t *doc) {
+static void append_audio_meta(AVFormatContext *pFormatCtx, document_t *doc) {
 
     AVDictionaryEntry *tag = NULL;
     while ((tag = av_dict_get(pFormatCtx->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
@@ -152,7 +160,7 @@ void append_audio_meta(AVFormatContext *pFormatCtx, document_t *doc) {
 }
 
 __always_inline
-void append_video_meta(AVFormatContext *pFormatCtx, AVFrame *frame, document_t *doc, int include_audio_tags, int is_video) {
+static void append_video_meta(AVFormatContext *pFormatCtx, AVFrame *frame, document_t *doc, int include_audio_tags, int is_video) {
 
     if (is_video) {
         meta_line_t *meta_duration = malloc(sizeof(meta_line_t));
@@ -184,6 +192,24 @@ void append_video_meta(AVFormatContext *pFormatCtx, AVFrame *frame, document_t *
                 APPEND_TAG_META(doc, tag, MetaArtist)
             } else if (strcmp(tag->key, "ImageDescription") == 0) {
                 APPEND_TAG_META(doc, tag, MetaContent)
+            } else if (strcmp(tag->key, "Make") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifMake)
+            } else if (strcmp(tag->key, "Model") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifModel)
+            } else if (strcmp(tag->key, "Software") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifSoftware)
+            } else if (strcmp(tag->key, "FNumber") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifFNumber)
+            } else if (strcmp(tag->key, "FocalLength") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifFocalLength)
+            } else if (strcmp(tag->key, "UserComment") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifUserComment)
+            } else if (strcmp(tag->key, "ISOSpeedRatings") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifIsoSpeedRatings)
+            } else if (strcmp(tag->key, "ExposureTime") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifExposureTime)
+            } else if (strcmp(tag->key, "DateTime") == 0) {
+                APPEND_TAG_META(doc, tag, MetaExifDateTime)
             }
         }
     }
@@ -259,7 +285,7 @@ void parse_media(AVFormatContext *pFormatCtx, document_t *doc) {
             }
         }
 
-        AVFrame *frame = read_frame(pFormatCtx, decoder, video_stream);
+        AVFrame *frame = read_frame(pFormatCtx, decoder, video_stream, doc);
         if (frame == NULL) {
             avcodec_free_context(&decoder);
             avformat_close_input(&pFormatCtx);
@@ -308,12 +334,14 @@ void parse_media_filename(const char *filepath, document_t *doc) {
 
     AVFormatContext *pFormatCtx = avformat_alloc_context();
     if (pFormatCtx == NULL) {
-        fprintf(stderr, "Could not allocate AVFormatContext! %s \n", filepath);
+        LOG_ERROR(doc->filepath, "(media.c) Could not allocate context with avformat_alloc_context()")
         return;
     }
     int res = avformat_open_input(&pFormatCtx, filepath, NULL, NULL);
     if (res < 0) {
-        fprintf(stderr, "media error: %s %s\n", filepath, av_err2str(res));
+        LOG_ERRORF(doc->filepath, "(media.c) avformat_open_input() returned [%d] %s", res, av_err2str(res))
+        avformat_close_input(&pFormatCtx);
+        avformat_free_context(pFormatCtx);
         return;
     }
 
@@ -336,7 +364,7 @@ void parse_media_vfile(struct vfile *f, document_t *doc) {
 
     AVFormatContext *pFormatCtx = avformat_alloc_context();
     if (pFormatCtx == NULL) {
-        fprintf(stderr, "Could not allocate AVFormatContext! %s \n", f->filepath);
+        LOG_ERROR(doc->filepath, "(media.c) Could not allocate context with avformat_alloc_context()")
         return;
     }
 
@@ -349,13 +377,22 @@ void parse_media_vfile(struct vfile *f, document_t *doc) {
     int res = avformat_open_input(&pFormatCtx, "", NULL, NULL);
     if (res == -5) {
         // Tried to parse media that requires seek
+        av_free(io_ctx->buffer);
+        avio_context_free(&io_ctx);
+        avformat_close_input(&pFormatCtx);
+        avformat_free_context(pFormatCtx);
         return;
-    } else if(res < 0) {
-        fprintf(stderr, "media error: %s %s\n", f->filepath, av_err2str(res));
+    } else if (res < 0) {
+        LOG_ERRORF(doc->filepath, "(media.c) avformat_open_input() returned [%d] %s", res, av_err2str(res))
+        av_free(io_ctx->buffer);
+        avio_context_free(&io_ctx);
+        avformat_close_input(&pFormatCtx);
+        avformat_free_context(pFormatCtx);
         return;
     }
 
     parse_media(pFormatCtx, doc);
-    av_free(io_ctx);
+    av_free(io_ctx->buffer);
+    avio_context_free(&io_ctx);
 }
 

src/parsing/mime.h

@@ -8,7 +8,7 @@
 #define MIME_EMPTY 1
 
 #define DONT_PARSE 0x80000000
-#define SHOULD_PARSE(mime_id) (mime_id & DONT_PARSE) != DONT_PARSE && mime_id != 0
+#define SHOULD_PARSE(mime_id) (ScanCtx.fast == 0 && (mime_id & DONT_PARSE) != DONT_PARSE && mime_id != 0)
 
 #define PDF_MASK 0x40000000
 #define IS_PDF(mime_id) (mime_id & PDF_MASK) == PDF_MASK

src/parsing/mime_generated.c

@@ -1193,6 +1193,8 @@ g_hash_table_insert(ext_table, "srt", (gpointer)text_plain);
 g_hash_table_insert(ext_table, "nfo", (gpointer)text_plain);
 g_hash_table_insert(ext_table, "sfv", (gpointer)text_plain);
 g_hash_table_insert(ext_table, "m3u", (gpointer)text_plain);
+g_hash_table_insert(ext_table, "csv", (gpointer)text_plain);
+g_hash_table_insert(ext_table, "eml", (gpointer)text_plain);
 g_hash_table_insert(ext_table, "rt", (gpointer)text_richtext);
 g_hash_table_insert(ext_table, "rtf", (gpointer)text_richtext);
 g_hash_table_insert(ext_table, "rtx", (gpointer)text_richtext);
@@ -1291,6 +1293,7 @@ g_hash_table_insert(ext_table, "isu", (gpointer)video_x_isvideo);
 g_hash_table_insert(ext_table, "mjpg", (gpointer)video_x_motion_jpeg);
 g_hash_table_insert(ext_table, "asf", (gpointer)video_x_ms_asf);
 g_hash_table_insert(ext_table, "asx", (gpointer)video_x_ms_asf);
+g_hash_table_insert(ext_table, "wmv", (gpointer)video_x_ms_asf);
 g_hash_table_insert(ext_table, "qtc", (gpointer)video_x_qtc);
 g_hash_table_insert(ext_table, "movie", (gpointer)video_x_sgi_movie);
 g_hash_table_insert(ext_table, "mv", (gpointer)video_x_sgi_movie);

src/parsing/parse.c

@@ -1,4 +1,3 @@
-#include <src/ctx.h>
 #include "src/sist.h"
 #include "src/ctx.h"
 
@@ -9,8 +8,7 @@ int fs_read(struct vfile *f, void *buf, size_t size) {
     if (f->fd == -1) {
         f->fd = open(f->filepath, O_RDONLY);
         if (f->fd == -1) {
-            perror("open");
-            printf("%s\n", f->filepath);
+            LOG_ERRORF(f->filepath, "open(): [%d] %s", errno, strerror(errno))
             return -1;
         }
     }
@@ -38,8 +36,8 @@ void *read_all(parse_job_t *job, const char *buf, int bytes_read) {
         memcpy(full_buf, buf, bytes_read);
 
         int ret = job->vfile.read(&job->vfile, full_buf + bytes_read, job->info.st_size - bytes_read);
-        if (ret == -1) {
-            perror("read");
+        if (ret < 0) {
+            LOG_ERRORF(job->filepath, "read(): [%d] %s", errno, strerror(errno))
             return NULL;
         }
     }
@@ -60,6 +58,7 @@ void parse(void *arg) {
 
     if (Magic == NULL) {
         Magic = magic_open(MAGIC_MIME_TYPE);
+        magic_load(Magic, NULL);
     }
 
     doc.filepath = job->filepath;
@@ -75,6 +74,12 @@ void parse(void *arg) {
     uuid_generate(doc.uuid);
     char *buf[PARSE_BUF_SIZE];
 
+    if (LogCtx.very_verbose) {
+        char uuid_str[UUID_STR_LEN];
+        uuid_unparse(doc.uuid, uuid_str);
+        LOG_DEBUGF(job->filepath, "Starting parse job {%s}", uuid_str)
+    }
+
     if (job->info.st_size == 0) {
         doc.mime = MIME_EMPTY;
     } else if (*(job->filepath + job->ext) != '\0' && (job->ext - job->base != 1)) {
@@ -83,10 +88,11 @@ void parse(void *arg) {
 
     int bytes_read = 0;
 
-    if (doc.mime == 0) {
+    if (doc.mime == 0 && !ScanCtx.fast) {
         // Get mime type with libmagic
         bytes_read = job->vfile.read(&job->vfile, buf, PARSE_BUF_SIZE);
-        if (bytes_read == -1) {
+        if (bytes_read < 0) {
+            LOG_WARNINGF(job->filepath, "read() Error: %s", strerror(errno))
             CLOSE_FILE(job->vfile)
             return;
         }
@@ -94,10 +100,16 @@ void parse(void *arg) {
         const char *magic_mime_str = magic_buffer(Magic, buf, bytes_read);
         if (magic_mime_str != NULL) {
             doc.mime = mime_get_mime_by_string(ScanCtx.mime_table, magic_mime_str);
+
+            LOG_DEBUGF(job->filepath, "libmagic: %s", magic_mime_str);
+
             if (doc.mime == 0) {
-                fprintf(stderr, "Couldn't find mime %s, %s\n", magic_mime_str, job->filepath + job->base);
+                LOG_WARNINGF(job->filepath, "Couldn't find mime %s", magic_mime_str);
             }
         }
+
+        magic_close(Magic);
+        Magic = NULL;
     }
 
     int mmime = MAJOR_MIME(doc.mime);
@@ -107,11 +119,11 @@ void parse(void *arg) {
     } else if ((mmime == MimeVideo && doc.size >= MIN_VIDEO_SIZE) ||
                (mmime == MimeImage && doc.size >= MIN_IMAGE_SIZE) || mmime == MimeAudio) {
 
-        if (job->vfile.is_fs_file) {
-            parse_media_filename(job->filepath, &doc);
-        } else {
-            parse_media_vfile(&job->vfile, &doc);
-        }
+//        if (job->vfile.is_fs_file) {
+//            parse_media_filename(job->filepath, &doc);
+//        } else {
+//            parse_media_vfile(&job->vfile, &doc);
+//        }
 
     } else if (IS_PDF(doc.mime)) {
         void *pdf_buf = read_all(job, (char *) buf, bytes_read);
@@ -144,6 +156,13 @@ void parse(void *arg) {
         if (doc_buf != buf && doc_buf != NULL) {
             free(doc_buf);
         }
+    } else if (is_cbr(doc.mime)) {
+        void *cbr_buf = read_all(job, (char *) buf, bytes_read);
+        parse_cbr(cbr_buf, doc.size, &doc);
+
+        if (cbr_buf != buf && cbr_buf != NULL) {
+            free(cbr_buf);
+        }
     }
 
     //Parent meta

src/parsing/pdf.c

@@ -1,12 +1,18 @@
 #include "pdf.h"
 #include "src/ctx.h"
 
-fz_page *render_cover(fz_context *ctx, document_t *doc, fz_document *fzdoc) {
+#define MIN_OCR_SIZE 350
+#define MIN_OCR_LEN 10
+__thread text_buffer_t thread_buffer;
+
+
+int render_cover(fz_context *ctx, document_t *doc, fz_document *fzdoc) {
 
     int err = 0;
     fz_page *cover = NULL;
 
     fz_var(cover);
+    fz_var(err);
     fz_try(ctx)
         cover = fz_load_page(ctx, fzdoc, 0);
     fz_catch(ctx)
@@ -14,7 +20,8 @@ fz_page *render_cover(fz_context *ctx, document_t *doc, fz_document *fzdoc) {
 
     if (err != 0) {
         fz_drop_page(ctx, cover);
-        return NULL;
+        LOG_WARNINGF(doc->filepath, "fz_load_page() returned error code [%d] %s", err, ctx->error.message)
+        return FALSE;
     }
 
     fz_rect bounds = fz_bound_page(ctx, cover);
@@ -52,9 +59,10 @@ fz_page *render_cover(fz_context *ctx, document_t *doc, fz_document *fzdoc) {
         err = ctx->error.errcode;
 
     if (err != 0) {
+        LOG_WARNINGF(doc->filepath, "fz_run_page() returned error code [%d] %s", err, ctx->error.message)
         fz_drop_page(ctx, cover);
         fz_drop_pixmap(ctx, pixmap);
-        return NULL;
+        return FALSE;
     }
 
     fz_buffer *fzbuf = NULL;
@@ -74,26 +82,37 @@ fz_page *render_cover(fz_context *ctx, document_t *doc, fz_document *fzdoc) {
 
     fz_drop_buffer(ctx, fzbuf);
     fz_drop_pixmap(ctx, pixmap);
+    fz_drop_page(ctx, cover);
 
     if (err != 0) {
-        fz_drop_page(ctx, cover);
-        return NULL;
+        LOG_WARNINGF(doc->filepath, "fz_new_buffer_from_pixmap_as_png() returned error code [%d] %s", err,
+                     ctx->error.message)
+        return FALSE;
     }
 
-    return cover;
+    return TRUE;
 }
 
-void fz_noop_callback(__attribute__((unused)) void *user, __attribute__((unused)) const char *message) {}
+void fz_err_callback(void *user, UNUSED(const char *message)) {
+    if (LogCtx.verbose) {
+        document_t *doc = (document_t *) user;
+        LOG_WARNINGF(doc->filepath, "FZ: %s", message)
+    }
+}
 
-
-void init_ctx(fz_context *ctx) {
+__always_inline
+static void init_ctx(fz_context *ctx, document_t *doc) {
     fz_disable_icc(ctx);
     fz_register_document_handlers(ctx);
-    ctx->warn.print = fz_noop_callback;
-    ctx->error.print = fz_noop_callback;
+
+    ctx->warn.print_user = doc;
+    ctx->warn.print = fz_err_callback;
+    ctx->error.print_user = doc;
+    ctx->error.print = fz_err_callback;
 }
 
-int read_stext_block(fz_stext_block *block, text_buffer_t *tex) {
+__always_inline
+static int read_stext_block(fz_stext_block *block, text_buffer_t *tex) {
     if (block->type != FZ_STEXT_BLOCK_TEXT) {
         return 0;
     }
@@ -112,6 +131,43 @@ int read_stext_block(fz_stext_block *block, text_buffer_t *tex) {
     return 0;
 }
 
+#define IS_VALID_BPP(d) (d==1 || d==2 || d==4 || d==8 || d==16 || d==24 || d==32)
+
+void fill_image(fz_context *ctx, UNUSED(fz_device *dev),
+                fz_image *img, UNUSED(fz_matrix ctm), UNUSED(float alpha),
+                UNUSED(fz_color_params color_params)) {
+
+    int l2factor = 0;
+
+    if (img->w > MIN_OCR_SIZE && img->h > MIN_OCR_SIZE && IS_VALID_BPP(img->n)) {
+
+        fz_pixmap *pix = img->get_pixmap(ctx, img, NULL, img->w, img->h, &l2factor);
+
+        if (pix->h > MIN_OCR_SIZE && img->h > MIN_OCR_SIZE && img->xres != 0) {
+            TessBaseAPI *api = TessBaseAPICreate();
+            TessBaseAPIInit3(api, ScanCtx.tesseract_path, ScanCtx.tesseract_lang);
+
+            TessBaseAPISetImage(api, pix->samples, pix->w, pix->h, pix->n, pix->stride);
+            TessBaseAPISetSourceResolution(api, pix->xres);
+
+            char *text = TessBaseAPIGetUTF8Text(api);
+            size_t len = strlen(text);
+            if (len >= MIN_OCR_LEN) {
+                text_buffer_append_string(&thread_buffer, text, len - 1);
+                LOG_DEBUGF(
+                        "pdf.c",
+                        "(OCR) %dx%d got %dB from tesseract (%s), buffer:%dB",
+                        pix->w, pix->h, len, ScanCtx.tesseract_lang, thread_buffer.dyn_buffer.cur
+                )
+            }
+
+            TessBaseAPIEnd(api);
+            TessBaseAPIDelete(api);
+        }
+        fz_drop_pixmap(ctx, pix);
+    }
+}
+
 void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
 
     if (buf == NULL) {
@@ -125,7 +181,7 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
     }
     fz_context *ctx = fz_new_context(NULL, NULL, FZ_STORE_UNLIMITED);
 
-    init_ctx(ctx);
+    init_ctx(ctx, doc);
 
     int err = 0;
 
@@ -143,7 +199,7 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
     fz_catch(ctx)
         err = ctx->error.errcode;
 
-    if (err) {
+    if (err != 0) {
         fz_drop_stream(ctx, stream);
         fz_drop_document(ctx, fzdoc);
         fz_drop_context(ctx);
@@ -171,24 +227,18 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
         err = ctx->error.errcode;
 
     if (err) {
+        LOG_WARNINGF(doc->filepath, "fz_count_pages() returned error code [%d] %s", err, ctx->error.message)
         fz_drop_stream(ctx, stream);
         fz_drop_document(ctx, fzdoc);
         fz_drop_context(ctx);
         return;
     }
 
-    fz_page *cover = NULL;
     if (ScanCtx.tn_size > 0) {
-        cover = render_cover(ctx, doc, fzdoc);
-    } else {
-        fz_var(cover);
-        fz_try(ctx)
-            cover = fz_load_page(ctx, fzdoc, 0);
-        fz_catch(ctx)
-            cover = NULL;
+        err = render_cover(ctx, doc, fzdoc);
     }
 
-    if (cover == NULL) {
+    if (err == TRUE) {
         fz_drop_stream(ctx, stream);
         fz_drop_document(ctx, fzdoc);
         fz_drop_context(ctx);
@@ -197,44 +247,51 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
 
     if (ScanCtx.content_size > 0) {
         fz_stext_options opts = {0};
-        text_buffer_t text_buf = text_buffer_create(ScanCtx.content_size);
+        thread_buffer = text_buffer_create(ScanCtx.content_size);
 
         for (int current_page = 0; current_page < page_count; current_page++) {
             fz_page *page = NULL;
-            if (current_page == 0) {
-                page = cover;
-            } else {
-                fz_var(err);
-                fz_try(ctx)
-                            page = fz_load_page(ctx, fzdoc, current_page);
-                fz_catch(ctx)
-                    err = ctx->error.errcode;
-                if (err != 0) {
-                    text_buffer_destroy(&text_buf);
-                    fz_drop_page(ctx, page);
-                    fz_drop_stream(ctx, stream);
-                    fz_drop_document(ctx, fzdoc);
-                    fz_drop_context(ctx);
-                    return;
-                }
+            fz_var(err);
+            fz_try(ctx)
+                page = fz_load_page(ctx, fzdoc, current_page);
+            fz_catch(ctx)
+                err = ctx->error.errcode;
+            if (err != 0) {
+                LOG_WARNINGF(doc->filepath, "fz_load_page() returned error code [%d] %s", err, ctx->error.message)
+                text_buffer_destroy(&thread_buffer);
+                fz_drop_page(ctx, page);
+                fz_drop_stream(ctx, stream);
+                fz_drop_document(ctx, fzdoc);
+                fz_drop_context(ctx);
+                return;
             }
 
             fz_stext_page *stext = fz_new_stext_page(ctx, fz_bound_page(ctx, page));
             fz_device *dev = fz_new_stext_device(ctx, stext, &opts);
+            dev->stroke_path = NULL;
+            dev->stroke_text = NULL;
+            dev->clip_text = NULL;
+            dev->clip_stroke_path = NULL;
+            dev->clip_stroke_text = NULL;
+
+            if (ScanCtx.tesseract_lang != NULL) {
+                dev->fill_image = fill_image;
+            }
 
             fz_var(err);
             fz_try(ctx)
-                        fz_run_page(ctx, page, dev, fz_identity, NULL);
+                fz_run_page(ctx, page, dev, fz_identity, NULL);
             fz_always(ctx)
-                {
-                    fz_close_device(ctx, dev);
-                    fz_drop_device(ctx, dev);
-                }
+            {
+                fz_close_device(ctx, dev);
+                fz_drop_device(ctx, dev);
+            }
             fz_catch(ctx)
                 err = ctx->error.errcode;
 
             if (err != 0) {
-                text_buffer_destroy(&text_buf);
+                LOG_WARNINGF(doc->filepath, "fz_run_page() returned error code [%d] %s", err, ctx->error.message)
+                text_buffer_destroy(&thread_buffer);
                 fz_drop_page(ctx, page);
                 fz_drop_stext_page(ctx, stext);
                 fz_drop_stream(ctx, stream);
@@ -245,7 +302,7 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
 
             fz_stext_block *block = stext->first_block;
             while (block != NULL) {
-                int ret = read_stext_block(block, &text_buf);
+                int ret = read_stext_block(block, &thread_buffer);
                 if (ret == TEXT_BUF_FULL) {
                     break;
                 }
@@ -254,22 +311,21 @@ void parse_pdf(void *buf, size_t buf_len, document_t *doc) {
             fz_drop_stext_page(ctx, stext);
             fz_drop_page(ctx, page);
 
-            if (text_buf.dyn_buffer.cur >= text_buf.dyn_buffer.size) {
+            if (thread_buffer.dyn_buffer.cur >= thread_buffer.dyn_buffer.size) {
                 break;
             }
         }
-        text_buffer_terminate_string(&text_buf);
+        text_buffer_terminate_string(&thread_buffer);
 
-        meta_line_t *meta_content = malloc(sizeof(meta_line_t) + text_buf.dyn_buffer.cur);
+        meta_line_t *meta_content = malloc(sizeof(meta_line_t) + thread_buffer.dyn_buffer.cur);
         meta_content->key = MetaContent;
-        memcpy(meta_content->strval, text_buf.dyn_buffer.buf, text_buf.dyn_buffer.cur);
+        memcpy(meta_content->strval, thread_buffer.dyn_buffer.buf, thread_buffer.dyn_buffer.cur);
         APPEND_META(doc, meta_content)
 
-        text_buffer_destroy(&text_buf);
+        text_buffer_destroy(&thread_buffer);
     }
 
     fz_drop_stream(ctx, stream);
     fz_drop_document(ctx, fzdoc);
     fz_drop_context(ctx);
 }
-

src/parsing/text.c

@@ -25,6 +25,7 @@ void parse_text(int bytes_read, struct vfile *f, char *buf, document_t *doc) {
     }
     text_buffer_t tex = text_buffer_create(ScanCtx.content_size);
     text_buffer_append_string(&tex, intermediate_buf, intermediate_buf_len);
+    text_buffer_terminate_string(&tex);
 
     meta_line_t *meta = malloc(sizeof(meta_line_t) + tex.dyn_buffer.cur);
     meta->key = MetaContent;

src/sist.h

@@ -2,6 +2,7 @@
 #define SIST_H
 
 #define UUID_STR_LEN 37
+#define UNUSED(x) __attribute__((__unused__))  x
 
 #include <glib-2.0/glib.h>
 #include <unistd.h>
@@ -12,11 +13,11 @@
 #include <ftw.h>
 #include <uuid.h>
 #include <magic.h>
-#include <libavformat/avformat.h>
-#include <libswscale/swscale.h>
-#include <libswresample/swresample.h>
-#include <libavcodec/avcodec.h>
-#include <libavutil/imgutils.h>
+#include "libavformat/avformat.h"
+#include "libswscale/swscale.h"
+#include "libswresample/swresample.h"
+#include "libavcodec/avcodec.h"
+#include "libavutil/imgutils.h"
 #include <ctype.h>
 #include <mupdf/fitz.h>
 #include <mupdf/pdf.h>
@@ -30,22 +31,24 @@
 #include "freetype/freetype.h"
 #include <archive.h>
 #include <archive_entry.h>
-#include <opc/opc.h>
 #include <libxml/xmlstring.h>
+#include <libxml/parser.h>
+#define BOOL int
+#include <tesseract/capi.h>
+#include <pcre.h>
 
-#ifndef SIST_SCAN_ONLY
 #include <onion/onion.h>
 #include <onion/handler.h>
 #include <onion/block.h>
 #include <onion/shortcuts.h>
 #include <onion/codecs.h>
 #include <curl/curl.h>
-#endif
 
 #include "cJSON/cJSON.h"
 
 #include "types.h"
 #include "tpool.h"
+#include "utf8.h/utf8.h"
 #include "util.h"
 #include "io/store.h"
 #include "io/serialize.h"
@@ -58,15 +61,14 @@
 #include "parsing/font.h"
 #include "parsing/arc.h"
 #include "parsing/doc.h"
+#include "parsing/cbr.h"
 #include "cli.h"
-#include "utf8.h/utf8.h"
+#include "log.h"
 
-#ifndef SIST_SCAN_ONLY
 #include "src/index/elastic.h"
 #include "index/web.h"
 #include "web/serve.h"
 #include "web/auth_basic.h"
-#endif
 
 ;
 

src/tpool.c

@@ -136,6 +136,7 @@ static void *tpool_worker(void *arg) {
         pthread_mutex_unlock(&(pool->work_mutex));
     }
 
+    LOG_INFO("tpool.c", "Executing cleaup function")
     pool->cleanup_func();
 
     pthread_cond_signal(&(pool->working_cond));
@@ -144,6 +145,7 @@ static void *tpool_worker(void *arg) {
 }
 
 void tpool_wait(tpool_t *pool) {
+    LOG_INFO("tpool.c", "Waiting for worker threads to finish")
     pthread_mutex_lock(&(pool->work_mutex));
     while (1) {
         if (pool->done_cnt < pool->work_cnt) {
@@ -159,6 +161,8 @@ void tpool_wait(tpool_t *pool) {
     }
     progress_bar_print(1.0, ScanCtx.stat_tn_size, ScanCtx.stat_index_size);
     pthread_mutex_unlock(&(pool->work_mutex));
+
+    LOG_INFO("tpool.c", "Worker threads finished")
 }
 
 void tpool_destroy(tpool_t *pool) {
@@ -166,6 +170,8 @@ void tpool_destroy(tpool_t *pool) {
         return;
     }
 
+    LOG_INFO("tpool.c", "Destroying thread pool")
+
     pthread_mutex_lock(&(pool->work_mutex));
     tpool_work_t *work = pool->work_head;
     while (work != NULL) {
@@ -185,6 +191,8 @@ void tpool_destroy(tpool_t *pool) {
         }
     }
 
+    LOG_INFO("tpool.c", "Final cleanup")
+
     pthread_mutex_destroy(&(pool->work_mutex));
     pthread_cond_destroy(&(pool->has_work_cond));
     pthread_cond_destroy(&(pool->working_cond));
@@ -220,6 +228,8 @@ tpool_t *tpool_create(size_t thread_cnt, void cleanup_func()) {
 
 void tpool_start(tpool_t *pool) {
 
+    LOG_INFOF("tpool.c", "Starting thread pool with %d threads", pool->thread_cnt)
+
     for (size_t i = 0; i < pool->thread_cnt; i++) {
         pthread_create(&pool->threads[i], NULL, tpool_worker, pool);
     }

src/types.h

@@ -2,9 +2,9 @@
 #define SIST2_TYPES_H
 
 
-#define META_INT_MASK 0xF0
-#define META_STR_MASK 0xE0
-#define META_LONG_MASK 0xD0
+#define META_INT_MASK 0x80
+#define META_STR_MASK 0x40
+#define META_LONG_MASK 0x20
 #define IS_META_INT(key) (key & META_INT_MASK) == META_INT_MASK
 #define IS_META_LONG(key) (key & META_LONG_MASK) == META_LONG_MASK
 #define IS_META_STR(meta) (meta->key & META_STR_MASK) == META_STR_MASK
@@ -31,16 +31,31 @@ enum metakey {
     MetaTitle = 12 | META_STR_MASK,
     MetaFontName = 13 | META_STR_MASK,
     MetaParent = 14 | META_STR_MASK,
+    MetaExifMake = 15 | META_STR_MASK,
+    MetaExifSoftware = 16 | META_STR_MASK,
+    MetaExifExposureTime = 17 | META_STR_MASK,
+    MetaExifFNumber = 18 | META_STR_MASK,
+    MetaExifFocalLength = 19 | META_STR_MASK,
+    MetaExifUserComment = 20 | META_STR_MASK,
+    MetaExifModel = 21 | META_STR_MASK,
+    MetaExifIsoSpeedRatings = 22 | META_STR_MASK,
+    MetaExifDateTime = 23 | META_STR_MASK,
+    //Note to self: this will break after 31 entries
 };
 
+#define INDEX_TYPE_BIN "binary"
+#define INDEX_TYPE_JSON "json"
+#define INDEX_VERSION_EXTERNAL "_external_v1"
+
 typedef struct index_descriptor {
     char uuid[UUID_STR_LEN];
-    char version[6];
+    char version[64];
     long timestamp;
     char root[PATH_MAX];
     char rewrite_url[8196];
     short root_len;
     char name[1024];
+    char type[64];
 } index_descriptor_t;
 
 typedef struct index_t {
@@ -70,8 +85,6 @@ typedef struct document {
     short ext;
     meta_line_t *meta_head;
     meta_line_t *meta_tail;
-    struct document *child_head;
-    struct document *child_tail;
     char *filepath;
 } document_t;
 
@@ -79,12 +92,9 @@ typedef struct vfile vfile_t;
 
 typedef int (*read_func_t)(struct vfile *, void *buf, size_t size);
 
-typedef int (*seek_func_t)(struct vfile *, size_t size, int whence);
-
 typedef void (*close_func_t)(struct vfile *);
 
 typedef struct vfile {
-
     union {
         int fd;
         struct archive *arc;

src/util.c

@@ -1,232 +1,5 @@
 #include "util.h"
-
-dyn_buffer_t dyn_buffer_create() {
-    dyn_buffer_t buf;
-
-    buf.size = INITIAL_BUF_SIZE;
-    buf.cur = 0;
-    buf.buf = malloc(INITIAL_BUF_SIZE);
-
-    return buf;
-}
-
-void grow_buffer(dyn_buffer_t *buf, size_t size) {
-    if (buf->cur + size > buf->size) {
-        do {
-            buf->size *= 2;
-        } while (buf->cur + size > buf->size);
-
-        buf->buf = realloc(buf->buf, buf->size);
-    }
-}
-
-void grow_buffer_small(dyn_buffer_t *buf) {
-    if (buf->cur + sizeof(long) > buf->size) {
-        buf->size *= 2;
-        buf->buf = realloc(buf->buf, buf->size);
-    }
-}
-
-void dyn_buffer_write(dyn_buffer_t *buf, void *data, size_t size) {
-    grow_buffer(buf, size);
-
-    memcpy(buf->buf + buf->cur, data, size);
-    buf->cur += size;
-}
-
-void dyn_buffer_write_char(dyn_buffer_t *buf, char c) {
-    grow_buffer_small(buf);
-
-    *(buf->buf + buf->cur) = c;
-    buf->cur += sizeof(c);
-}
-
-void dyn_buffer_write_str(dyn_buffer_t *buf, char *str) {
-    dyn_buffer_write(buf, str, strlen(str));
-    dyn_buffer_write_char(buf, '\0');
-}
-
-void dyn_buffer_append_string(dyn_buffer_t *buf, char *str) {
-    dyn_buffer_write(buf, str, strlen(str));
-}
-
-void dyn_buffer_write_int(dyn_buffer_t *buf, int d) {
-    grow_buffer_small(buf);
-
-    *(int *) (buf->buf + buf->cur) = d;
-    buf->cur += sizeof(int);
-}
-
-void dyn_buffer_write_short(dyn_buffer_t *buf, short s) {
-    grow_buffer_small(buf);
-
-    *(short *) (buf->buf + buf->cur) = s;
-    buf->cur += sizeof(short);
-}
-
-void dyn_buffer_write_long(dyn_buffer_t *buf, unsigned long l) {
-    grow_buffer_small(buf);
-
-    *(unsigned long *) (buf->buf + buf->cur) = l;
-    buf->cur += sizeof(unsigned long);
-}
-
-void dyn_buffer_destroy(dyn_buffer_t *buf) {
-    free(buf->buf);
-}
-
-void text_buffer_destroy(text_buffer_t *buf) {
-    dyn_buffer_destroy(&buf->dyn_buffer);
-}
-
-text_buffer_t text_buffer_create(int max_size) {
-    text_buffer_t text_buf;
-
-    text_buf.dyn_buffer = dyn_buffer_create();
-    text_buf.max_size = max_size;
-    text_buf.last_char_was_whitespace = FALSE;
-
-    return text_buf;
-}
-
-void text_buffer_terminate_string(text_buffer_t *buf) {
-    dyn_buffer_write_char(&buf->dyn_buffer, '\0');
-}
-
-__always_inline
-int utf8_validchr(const char *s) {
-    if (0x00 == (0x80 & *s)) {
-        return TRUE;
-    } else if (0xf0 == (0xf8 & *s)) {
-        if ((0x80 != (0xc0 & s[1])) || (0x80 != (0xc0 & s[2])) ||
-            (0x80 != (0xc0 & s[3]))) {
-            return FALSE;
-        }
-
-        if (0x80 == (0xc0 & s[4])) {
-            return FALSE;
-        }
-
-        if ((0 == (0x07 & s[0])) && (0 == (0x30 & s[1]))) {
-            return FALSE;
-        }
-    } else if (0xe0 == (0xf0 & *s)) {
-        if ((0x80 != (0xc0 & s[1])) || (0x80 != (0xc0 & s[2]))) {
-            return FALSE;
-        }
-
-        if (0x80 == (0xc0 & s[3])) {
-            return FALSE;
-        }
-
-        if ((0 == (0x0f & s[0])) && (0 == (0x20 & s[1]))) {
-            return FALSE;
-        }
-    } else if (0xc0 == (0xe0 & *s)) {
-        if (0x80 != (0xc0 & s[1])) {
-            return FALSE;
-        }
-
-        if (0x80 == (0xc0 & s[2])) {
-            return FALSE;
-        }
-
-        if (0 == (0x1e & s[0])) {
-            return FALSE;
-        }
-    } else {
-        return FALSE;
-    }
-
-    return TRUE;
-}
-
-int text_buffer_append_string(text_buffer_t *buf, char *str, size_t len) {
-
-    utf8_int32_t c;
-    if (str == NULL || len < 1 ||
-        (0xf0 == (0xf8 & str[0]) && len < 4) ||
-        (0xe0 == (0xf0 & str[0]) && len < 3) ||
-        (0xc0 == (0xe0 & str[0]) && len == 1) ||
-        *(str) == 0) {
-        text_buffer_terminate_string(buf);
-        return 0;
-    }
-
-    for (void *v = utf8codepoint(str, &c); c != '\0' && ((char *) v - str + 4) < len; v = utf8codepoint(v, &c)) {
-        if (utf8_validchr(v)) {
-            text_buffer_append_char(buf, c);
-        }
-    }
-    text_buffer_terminate_string(buf);
-    return 0;
-}
-
-int text_buffer_append_string0(text_buffer_t *buf, char *str) {
-    utf8_int32_t c;
-    for (void *v = utf8codepoint(str, &c); c != '\0'; v = utf8codepoint(v, &c)) {
-        if (utf8_validchr(v)) {
-            text_buffer_append_char(buf, c);
-        }
-    }
-    text_buffer_terminate_string(buf);
-}
-
-int text_buffer_append_char(text_buffer_t *buf, int c) {
-
-    if (SHOULD_IGNORE_CHAR(c)) {
-        if (!buf->last_char_was_whitespace) {
-            dyn_buffer_write_char(&buf->dyn_buffer, ' ');
-            buf->last_char_was_whitespace = TRUE;
-
-            if (buf->max_size > 0 && buf->dyn_buffer.cur >= buf->max_size) {
-                return TEXT_BUF_FULL;
-            }
-        }
-    } else {
-        buf->last_char_was_whitespace = FALSE;
-        grow_buffer_small(&buf->dyn_buffer);
-
-        if (0 == ((utf8_int32_t) 0xffffff80 & c)) {
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = (char) c;
-        } else if (0 == ((utf8_int32_t) 0xfffff800 & c)) {
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xc0 | (char) (c >> 6);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
-        } else if (0 == ((utf8_int32_t) 0xffff0000 & c)) {
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xe0 | (char) (c >> 12);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 6) & 0x3f);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
-        } else {
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xf0 | (char) (c >> 18);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 12) & 0x3f);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 6) & 0x3f);
-            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
-        }
-
-        if (buf->max_size > 0 && buf->dyn_buffer.cur >= buf->max_size) {
-            return TEXT_BUF_FULL;
-        }
-    }
-
-    return 0;
-}
-
-void incremental_put(GHashTable *table, unsigned long inode_no, int mtime) {
-    g_hash_table_insert(table, (gpointer) inode_no, GINT_TO_POINTER(mtime));
-}
-
-int incremental_get(GHashTable *table, unsigned long inode_no) {
-    if (table != NULL) {
-        return GPOINTER_TO_INT(g_hash_table_lookup(table, (gpointer) inode_no));
-    } else {
-        return 0;
-    }
-}
-
-int incremental_mark_file_for_copy(GHashTable *table, unsigned long inode_no) {
-    g_hash_table_insert(table, GINT_TO_POINTER(inode_no), GINT_TO_POINTER(1));
-}
-
+#include "src/ctx.h"
 
 #define PBSTR "========================================"
 #define PBWIDTH 40
@@ -257,8 +30,10 @@ char *abspath(const char *path) {
     if (abs == NULL) {
         return NULL;
     }
-    abs = realloc(abs, strlen(abs) + 2);
-    strcat(abs, "/");
+    if (strlen(abs) > 1) {
+        abs = realloc(abs, strlen(abs) + 2);
+        strcat(abs, "/");
+    }
 
     wordfree(&w);
     return abs;
@@ -320,4 +95,29 @@ GHashTable *incremental_get_table() {
     return file_table;
 }
 
+const char *find_file_in_paths(const char *paths[], const char *filename) {
+
+    for (int i = 0; paths[i] != NULL; i++) {
+
+        char *apath = abspath(paths[i]);
+        if (apath == NULL) {
+            continue;
+        }
+
+        char path[PATH_MAX];
+        snprintf(path, sizeof(path), "%s%s", apath, filename);
+
+        LOG_DEBUGF("util.c", "Looking for '%s' in folder '%s'", filename, apath)
+        free(apath);
+
+        struct stat info;
+        int ret = stat(path, &info);
+        if (ret != -1) {
+            return paths[i];
+        }
+    }
+
+    return NULL;
+}
+
 

src/util.h

@@ -7,7 +7,7 @@
 #define INITIAL_BUF_SIZE 1024 * 16
 
 #define SHOULD_IGNORE_CHAR(c) !(SHOULD_KEEP_CHAR(c))
-#define SHOULD_KEEP_CHAR(c) (c >= (int)'!')
+#define SHOULD_KEEP_CHAR(c) ((c >= '\'' && c <= ';') || (c >= 'A' && c <= 'z') || (c > 127))
 
 
 typedef struct dyn_buffer {
@@ -32,47 +32,259 @@ dyn_buffer_t url_escape(char *str);
 
 void progress_bar_print(double percentage, size_t tn_size, size_t index_size);
 
-
 GHashTable *incremental_get_table();
 
-dyn_buffer_t dyn_buffer_create();
+__always_inline
+static int utf8_validchr2(const char *s) {
+    if (0x00 == (0x80 & *s)) {
+        return TRUE;
+    } else if (0xf0 == (0xf8 & *s)) {
+        if ((0x80 != (0xc0 & s[1])) || (0x80 != (0xc0 & s[2])) ||
+            (0x80 != (0xc0 & s[3]))) {
+            return FALSE;
+        }
 
-void grow_buffer(dyn_buffer_t *buf, size_t size);
+        if (0x80 == (0xc0 & s[4])) {
+            return FALSE;
+        }
 
-void grow_buffer_small(dyn_buffer_t *buf);
+        if ((0 == (0x07 & s[0])) && (0 == (0x30 & s[1]))) {
+            return FALSE;
+        }
+    } else if (0xe0 == (0xf0 & *s)) {
+        if ((0x80 != (0xc0 & s[1])) || (0x80 != (0xc0 & s[2]))) {
+            return FALSE;
+        }
 
-void dyn_buffer_write(dyn_buffer_t *buf, void *data, size_t size);
+        if (0x80 == (0xc0 & s[3])) {
+            return FALSE;
+        }
 
-void dyn_buffer_write_char(dyn_buffer_t *buf, char c);
+        if ((0 == (0x0f & s[0])) && (0 == (0x20 & s[1]))) {
+            return FALSE;
+        }
+    } else if (0xc0 == (0xe0 & *s)) {
+        if (0x80 != (0xc0 & s[1])) {
+            return FALSE;
+        }
 
-void dyn_buffer_write_str(dyn_buffer_t *buf, char *str);
+        if (0x80 == (0xc0 & s[2])) {
+            return FALSE;
+        }
 
-void dyn_buffer_append_string(dyn_buffer_t *buf, char *str);
+        if (0 == (0x1e & s[0])) {
+            return FALSE;
+        }
+    } else {
+        return FALSE;
+    }
 
-void dyn_buffer_write_int(dyn_buffer_t *buf, int d);
+    return TRUE;
+}
 
-void dyn_buffer_write_short(dyn_buffer_t *buf, short s);
 
-void dyn_buffer_write_long(dyn_buffer_t *buf, unsigned long l);
+__always_inline
+static dyn_buffer_t dyn_buffer_create() {
+    dyn_buffer_t buf;
 
-void dyn_buffer_destroy(dyn_buffer_t *buf);
+    buf.size = INITIAL_BUF_SIZE;
+    buf.cur = 0;
+    buf.buf = malloc(INITIAL_BUF_SIZE);
 
-void text_buffer_destroy(text_buffer_t *buf);
+    return buf;
+}
 
-text_buffer_t text_buffer_create(int max_size);
+__always_inline
+static void grow_buffer(dyn_buffer_t *buf, size_t size) {
+    if (buf->cur + size > buf->size) {
+        do {
+            buf->size *= 2;
+        } while (buf->cur + size > buf->size);
 
-void text_buffer_terminate_string(text_buffer_t *buf);
+        buf->buf = realloc(buf->buf, buf->size);
+    }
+}
 
-int text_buffer_append_string(text_buffer_t *buf, char *str, size_t len);
-int text_buffer_append_string0(text_buffer_t *buf, char *str);
+__always_inline
+static void grow_buffer_small(dyn_buffer_t *buf) {
+    if (buf->cur + sizeof(long) > buf->size) {
+        buf->size *= 2;
+        buf->buf = realloc(buf->buf, buf->size);
+    }
+}
 
-int text_buffer_append_char(text_buffer_t *buf, int c);
+__always_inline
+static void dyn_buffer_write(dyn_buffer_t *buf, void *data, size_t size) {
+    grow_buffer(buf, size);
 
-void incremental_put(GHashTable *table, unsigned long inode_no, int mtime);
+    memcpy(buf->buf + buf->cur, data, size);
+    buf->cur += size;
+}
 
-int incremental_get(GHashTable *table, unsigned long inode_no);
+__always_inline
+static void dyn_buffer_write_char(dyn_buffer_t *buf, char c) {
+    grow_buffer_small(buf);
 
-int incremental_mark_file_for_copy(GHashTable *table, unsigned long inode_no);
+    *(buf->buf + buf->cur) = c;
+    buf->cur += sizeof(c);
+}
 
+__always_inline
+static void dyn_buffer_write_str(dyn_buffer_t *buf, char *str) {
+    dyn_buffer_write(buf, str, strlen(str));
+    dyn_buffer_write_char(buf, '\0');
+}
+
+__always_inline
+static void dyn_buffer_append_string(dyn_buffer_t *buf, char *str) {
+    dyn_buffer_write(buf, str, strlen(str));
+}
+
+__always_inline
+static void dyn_buffer_write_int(dyn_buffer_t *buf, int d) {
+    grow_buffer_small(buf);
+
+    *(int *) (buf->buf + buf->cur) = d;
+    buf->cur += sizeof(int);
+}
+
+__always_inline
+static void dyn_buffer_write_short(dyn_buffer_t *buf, short s) {
+    grow_buffer_small(buf);
+
+    *(short *) (buf->buf + buf->cur) = s;
+    buf->cur += sizeof(short);
+}
+
+__always_inline
+static void dyn_buffer_write_long(dyn_buffer_t *buf, unsigned long l) {
+    grow_buffer_small(buf);
+
+    *(unsigned long *) (buf->buf + buf->cur) = l;
+    buf->cur += sizeof(unsigned long);
+}
+
+__always_inline
+static void dyn_buffer_destroy(dyn_buffer_t *buf) {
+    free(buf->buf);
+}
+
+__always_inline
+static void text_buffer_destroy(text_buffer_t *buf) {
+    dyn_buffer_destroy(&buf->dyn_buffer);
+}
+
+__always_inline
+static text_buffer_t text_buffer_create(int max_size) {
+    text_buffer_t text_buf;
+
+    text_buf.dyn_buffer = dyn_buffer_create();
+    text_buf.max_size = max_size;
+    text_buf.last_char_was_whitespace = FALSE;
+
+    return text_buf;
+}
+
+__always_inline
+static int text_buffer_append_char(text_buffer_t *buf, int c) {
+
+    if (SHOULD_IGNORE_CHAR(c) || c == ' ') {
+        if (!buf->last_char_was_whitespace && buf->dyn_buffer.cur != 0) {
+            dyn_buffer_write_char(&buf->dyn_buffer, ' ');
+            buf->last_char_was_whitespace = TRUE;
+
+            if (buf->max_size > 0 && buf->dyn_buffer.cur >= buf->max_size) {
+                return TEXT_BUF_FULL;
+            }
+        }
+    } else {
+        buf->last_char_was_whitespace = FALSE;
+        grow_buffer_small(&buf->dyn_buffer);
+
+        if (0 == ((utf8_int32_t) 0xffffff80 & c)) {
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = (char) c;
+        } else if (0 == ((utf8_int32_t) 0xfffff800 & c)) {
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xc0 | (char) (c >> 6);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
+        } else if (0 == ((utf8_int32_t) 0xffff0000 & c)) {
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xe0 | (char) (c >> 12);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 6) & 0x3f);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
+        } else {
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0xf0 | (char) (c >> 18);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 12) & 0x3f);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) ((c >> 6) & 0x3f);
+            *(buf->dyn_buffer.buf + buf->dyn_buffer.cur++) = 0x80 | (char) (c & 0x3f);
+        }
+
+        if (buf->max_size > 0 && buf->dyn_buffer.cur >= buf->max_size) {
+            return TEXT_BUF_FULL;
+        }
+    }
+
+    return 0;
+}
+
+
+__always_inline
+static void text_buffer_terminate_string(text_buffer_t *buf) {
+    if (buf->dyn_buffer.cur > 0 && *(buf->dyn_buffer.buf + buf->dyn_buffer.cur - 1) == ' ') {
+        *(buf->dyn_buffer.buf + buf->dyn_buffer.cur - 1) = '\0';
+    } else {
+        dyn_buffer_write_char(&buf->dyn_buffer, '\0');
+    }
+}
+
+__always_inline
+static int text_buffer_append_string(text_buffer_t *buf, char *str, size_t len) {
+
+    utf8_int32_t c;
+    if (str == NULL || len < 1 ||
+        (0xf0 == (0xf8 & str[0]) && len < 4) ||
+        (0xe0 == (0xf0 & str[0]) && len < 3) ||
+        (0xc0 == (0xe0 & str[0]) && len == 1) ||
+        *(str) == 0) {
+        return 0;
+    }
+
+    for (void *v = utf8codepoint(str, &c); c != '\0' && ((char *) v - str + 4) < len; v = utf8codepoint(v, &c)) {
+        if (utf8_validchr2(v)) {
+            text_buffer_append_char(buf, c);
+        }
+    }
+    return 0;
+}
+
+__always_inline
+static int text_buffer_append_string0(text_buffer_t *buf, char *str) {
+    utf8_int32_t c;
+    for (void *v = utf8codepoint(str, &c); c != '\0'; v = utf8codepoint(v, &c)) {
+        if (utf8_validchr2(v)) {
+            text_buffer_append_char(buf, c);
+        }
+    }
+}
+
+__always_inline
+static void incremental_put(GHashTable *table, unsigned long inode_no, int mtime) {
+    g_hash_table_insert(table, (gpointer) inode_no, GINT_TO_POINTER(mtime));
+}
+
+__always_inline
+static int incremental_get(GHashTable *table, unsigned long inode_no) {
+    if (table != NULL) {
+        return GPOINTER_TO_INT(g_hash_table_lookup(table, (gpointer) inode_no));
+    } else {
+        return 0;
+    }
+}
+
+__always_inline
+static int incremental_mark_file_for_copy(GHashTable *table, unsigned long inode_no) {
+    g_hash_table_insert(table, GINT_TO_POINTER(inode_no), GINT_TO_POINTER(1));
+}
+
+
+const char *find_file_in_paths(const char **paths, const char *filename);
 
 #endif

src/web/serve.c

@@ -110,7 +110,7 @@ int thumbnail(void *p, onion_request *req, onion_response *res) {
     int written = onion_response_write(res, data, data_len);
     onion_response_flush(res);
     if (written != data_len || data_len == 0) {
-        printf("Couldn't write thumb\n");
+        LOG_DEBUG("serve.c", "Couldn't write thumbnail");
     }
     free(data);
 
@@ -181,7 +181,12 @@ int chunked_response_file(const char *filename, const char *mime,
         }
     }
     onion_response_set_length(res, length);
-    onion_response_set_header(res, "Content-Type", mime);
+    if (mime != NULL) {
+        onion_response_set_header(res, "Content-Type", mime);
+    } else {
+        onion_response_set_header(res, "Content-Type", "application/octet-stream");
+    }
+
     onion_response_write_headers(res);
     if ((onion_request_get_flags(request) & OR_HEAD) == OR_HEAD) {
         length = 0;
@@ -214,21 +219,13 @@ int chunked_response_file(const char *filename, const char *mime,
     return OCS_PROCESSED;
 }
 
-int search(void *p, onion_request *req, onion_response *res) {
+int search(UNUSED(void *p), onion_request *req, onion_response *res) {
 
     int flags = onion_request_get_flags(req);
     if ((flags & OR_METHODS) != OR_POST) {
         return OCS_NOT_PROCESSED;
     }
 
-    char *scroll_param;
-    const char *scroll = onion_request_get_query(req, "scroll");
-    if (scroll != NULL) {
-        scroll_param = "?scroll=3m";
-    } else {
-        scroll_param = "";
-    }
-
     const struct onion_block_t *block = onion_request_get_data(req);
 
     if (block == NULL) {
@@ -236,7 +233,7 @@ int search(void *p, onion_request *req, onion_response *res) {
     }
 
     char url[4096];
-    snprintf(url, 4096, "%s/sist2/_search%s", WebCtx.es_url, scroll_param);
+    snprintf(url, 4096, "%s/sist2/_search", WebCtx.es_url);
     response_t *r = web_post(url, onion_block_data(block), "Content-Type: application/json");
 
     set_default_headers(res);
@@ -246,6 +243,7 @@ int search(void *p, onion_request *req, onion_response *res) {
     if (r->status_code == 200) {
         onion_response_write(res, r->body, r->size);
     } else {
+        sist_log("serve.c", SIST_WARNING, "ElasticSearch error during query");
         onion_response_set_code(res, HTTP_INTERNAL_ERROR);
     }
 
@@ -254,43 +252,6 @@ int search(void *p, onion_request *req, onion_response *res) {
     return OCS_PROCESSED;
 }
 
-int scroll(void *p, onion_request *req, onion_response *res) {
-
-    int flags = onion_request_get_flags(req);
-    if ((flags & OR_METHODS) != OR_GET) {
-        return OCS_NOT_PROCESSED;
-    }
-
-    char url[4096];
-    snprintf(url, 4096, "%s/_search/scroll", WebCtx.es_url);
-
-    const char *scroll_id = onion_request_get_query(req, "scroll_id");
-
-    cJSON *json = cJSON_CreateObject();
-    cJSON_AddStringToObject(json, "scroll_id", scroll_id);
-    cJSON_AddStringToObject(json, "scroll", "3m");
-
-    char *json_str = cJSON_PrintUnformatted(json);
-    response_t *r = web_post(url, json_str, "Content-Type: application/json");
-
-    cJSON_Delete(json);
-    cJSON_free(json_str);
-
-    if (r->status_code != 200) {
-        free_response(r);
-        return OCS_NOT_PROCESSED;
-    }
-
-    set_default_headers(res);
-    onion_response_set_header(res, "Content-Type", "application/json");
-    onion_response_set_header(res, "Content-Disposition", "application/json");
-    onion_response_set_length(res, r->size);
-    onion_response_write(res, r->body, r->size);
-    free_response(r);
-
-    return OCS_PROCESSED;
-}
-
 int serve_file_from_url(cJSON *json, index_t *idx, onion_request *req, onion_response *res) {
 
     const char *path = cJSON_GetObjectItem(json, "path")->valuestring;
@@ -327,7 +288,7 @@ int serve_file_from_disk(cJSON *json, index_t *idx, onion_request *req, onion_re
     return chunked_response_file(full_path, mime, 1, req, res);
 }
 
-int index_info(void *p, onion_request *req, onion_response *res) {
+int index_info(UNUSED(void *p), onion_request *req, onion_response *res) {
     cJSON *json = cJSON_CreateObject();
     cJSON *arr = cJSON_AddArrayToObject(json, "indices");
 
@@ -353,14 +314,47 @@ int index_info(void *p, onion_request *req, onion_response *res) {
     return OCS_PROCESSED;
 }
 
-int file(void *p, onion_request *req, onion_response *res) {
+
+int document_info(UNUSED(void *p), onion_request *req, onion_response *res) {
 
     const char *arg_uuid = onion_request_get_query(req, "1");
     if (arg_uuid == NULL) {
         return OCS_PROCESSED;
     }
 
-    char *next = arg_uuid;
+    cJSON *doc = elastic_get_document(arg_uuid);
+    cJSON *source = cJSON_GetObjectItem(doc, "_source");
+
+    cJSON *index_id = cJSON_GetObjectItem(source, "index");
+    if (index_id == NULL) {
+        cJSON_Delete(doc);
+        return OCS_NOT_PROCESSED;
+    }
+
+    index_t *idx = get_index_by_id(index_id->valuestring);
+    if (idx == NULL) {
+        cJSON_Delete(doc);
+        return OCS_NOT_PROCESSED;
+    }
+
+    onion_response_set_header(res, "Content-Type", "application/json");
+
+    char *json_str = cJSON_PrintUnformatted(source);
+    onion_response_write0(res, json_str);
+    free(json_str);
+    cJSON_Delete(doc);
+
+    return OCS_PROCESSED;
+}
+
+int file(UNUSED(void *p), onion_request *req, onion_response *res) {
+
+    const char *arg_uuid = onion_request_get_query(req, "1");
+    if (arg_uuid == NULL) {
+        return OCS_PROCESSED;
+    }
+
+    const char *next = arg_uuid;
     cJSON *doc = NULL;
     cJSON *index_id = NULL;
     cJSON *source = NULL;
@@ -398,6 +392,23 @@ int file(void *p, onion_request *req, onion_response *res) {
     return ret;
 }
 
+int status(UNUSED(void *p), UNUSED(onion_request *req), onion_response *res) {
+    set_default_headers(res);
+
+    onion_response_set_header(res, "Content-Type", "application/x-empty");
+
+    char *status = elastic_get_status();
+    if (strcmp(status, "open") == 0) {
+        onion_response_set_code(res, 204);
+    } else {
+        onion_response_set_code(res, 500);
+    }
+
+    free(status);
+
+    return OCS_PROCESSED;
+}
+
 void serve(const char *hostname, const char *port) {
     onion *o = onion_new(O_POOL);
     onion_set_timeout(o, 3500);
@@ -416,7 +427,7 @@ void serve(const char *hostname, const char *port) {
     onion_url_add(urls, "img/sprite-skin-flat.png", img_sprite_skin_flag);
 
     onion_url_add(urls, "es", search);
-    onion_url_add(urls, "scroll", scroll);
+    onion_url_add(urls, "status", status);
     onion_url_add(
             urls,
             "^t/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})/"
@@ -424,6 +435,7 @@ void serve(const char *hostname, const char *port) {
             thumbnail
     );
     onion_url_add(urls, "^f/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$", file);
+    onion_url_add(urls, "^d/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$", document_info);
     onion_url_add(urls, "i", index_info);
 
 

web/css/auto-complete.min.css

@@ -1,9 +0,0 @@
-.autocomplete-suggestions {
-    text-align: left; cursor: default; border: 1px solid #ccc; border-top: 0; background: #fff; box-shadow: -1px 1px 3px rgba(0,0,0,.1);
-
-    /* core styles should not be changed */
-    position: absolute; display: none; z-index: 9999; max-height: 254px; overflow: hidden; overflow-y: auto; box-sizing: border-box;
-}
-.autocomplete-suggestion { position: relative; padding: 0 .6em; line-height: 23px; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; font-size: 1.02em; color: #333; }
-.autocomplete-suggestion b { font-weight: normal; color: #1f8dd6; }
-.autocomplete-suggestion.selected { background: #f0f0f0; }

web/css/dark.css

@@ -2,6 +2,43 @@
     outline: 0;
 }
 
+.info-icon {
+    width: 1rem;
+    margin-right: 0.2rem;
+    cursor: pointer;
+    color: #757575;
+    line-height: 1rem;
+    height: 1.1rem;
+}
+
+.info-icon:hover {
+    color: inherit;
+}
+
+.modal-title {
+    max-width: calc(100% - 2rem);
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+
+
+.path-row {
+    display: -ms-flexbox;
+    display: flex;
+    -ms-flex-align: start;
+    align-items: flex-start;
+}
+
+.tag-container {
+    margin-left: 0.3rem;
+}
+
+.path-line {
+    color: #BBB;
+    text-overflow: ellipsis;
+    overflow: hidden;
+}
+
 a {
     color: #00BCD4;
 }
@@ -15,7 +52,7 @@ body {
     margin-top: 1em;
 }
 
-.card {
+.card, .modal-content {
     margin-top: 1em;
     background: #212121;
     color: #e0e0e0;
@@ -23,8 +60,33 @@ body {
     border: none;
 }
 
+.table {
+    color: #e0e0e0;
+}
+
+.table td, .table th {
+    border: none;
+}
+
+.table thead th {
+    border-bottom: 1px solid #646464;
+}
+
+.modal-header .close {
+    color: #e0e0e0;
+    text-shadow: none;
+}
+
+.modal-header {
+    border-bottom: 1px solid #646464;
+}
+
 .sub-document {
-    background: #37474F;
+    background: #37474F !important;
+}
+
+.list-group-item.sub-document {
+    border-top: 1px solid #646464 !important;
 }
 
 .sub-document .text-muted {
@@ -40,6 +102,7 @@ body {
     border-bottom: none;
     border-left: none;
     border-right: none;
+    padding: .25rem 0.5rem;
 }
 
 .list-group-item:first-child {
@@ -112,6 +175,9 @@ body {
 }
 
 .file-title {
+    width: 100%;
+    line-height: 1rem;
+    height: 1.1rem;
     font-size: 10pt;
     white-space: nowrap;
     text-overflow: ellipsis;
@@ -134,7 +200,7 @@ body {
     max-width: 100%;
     max-height: 175px;
     margin: 0 auto 0;
-    padding: 3px 3px 0 3px;
+    padding: 3px 3px 0;
     width: auto;
     height: auto;
 }
@@ -143,7 +209,7 @@ body {
     display: block;
     max-width: 64px;
     max-height: 64px;
-    margin: 0 auto 0;
+    margin: 0 auto;
     width: auto;
     height: auto;
 }
@@ -178,11 +244,18 @@ body {
 }
 
 mark {
-    background: #fff217;
+    background: rgba(251, 191, 41, 0.25);
     border-radius: 0;
     padding: 1px 0;
+    color: inherit;
 }
 
+.content-div mark {
+    background: rgba(251, 191, 41, 0.40);
+    color: white;
+}
+
+
 .content-div {
     font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
     font-size: 13px;
@@ -326,10 +399,6 @@ option {
     margin-top: 1em;
 }
 
-.list-group-item {
-    padding: .25rem 0.5rem;
-}
-
 .wrapper-sm {
     min-width: 64px;
 }
@@ -358,3 +427,33 @@ option {
     margin-top: -14px;
     font-size: 11px;
 }
+
+@media (min-width: 800px) {
+    .small-btn {
+        display: none;
+    }
+    .large-btn {
+        display: inherit;
+    }
+}
+
+@media (max-width: 801px) {
+    .small-btn {
+        display: inherit;
+    }
+    .large-btn {
+        display: none;
+    }
+}
+
+#searchBar {
+    border-right: none;
+}
+
+#pathTree .title {
+    cursor: pointer;
+}
+
+svg {
+    fill: white;
+}

web/css/jquery.toast.min.css

@@ -0,0 +1 @@
+.jq-toast-wrap,.jq-toast-wrap *{margin:0;padding:0}.jq-toast-wrap{display:block;position:fixed;width:250px;pointer-events:none!important;letter-spacing:normal;z-index:9000!important}.jq-toast-wrap.bottom-left{bottom:20px;left:20px}.jq-toast-wrap.bottom-right{bottom:20px;right:40px}.jq-toast-wrap.top-left{top:20px;left:20px}.jq-toast-wrap.top-right{top:20px;right:40px}.jq-toast-single{display:block;width:100%;padding:10px;margin:0 0 5px;border-radius:4px;font-size:12px;font-family:arial,sans-serif;line-height:17px;position:relative;pointer-events:all!important;background-color:#444;color:#fff}.jq-toast-single h2{font-family:arial,sans-serif;font-size:14px;margin:0 0 7px;background:0 0;color:inherit;line-height:inherit;letter-spacing:normal}.jq-toast-single a{color:#eee;text-decoration:none;font-weight:700;border-bottom:1px solid #fff;padding-bottom:3px;font-size:12px}.jq-toast-single ul{margin:0 0 0 15px;background:0 0;padding:0}.jq-toast-single ul li{list-style-type:disc!important;line-height:17px;background:0 0;margin:0;padding:0;letter-spacing:normal}.close-jq-toast-single{position:absolute;top:3px;right:7px;font-size:14px;cursor:pointer}.jq-toast-loader{display:block;position:absolute;top:-2px;height:5px;width:0;left:0;border-radius:5px;background:red}.jq-toast-loaded{width:100%}.jq-has-icon{padding:10px 10px 10px 50px;background-repeat:no-repeat;background-position:10px}.jq-icon-info{background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAGwSURBVEhLtZa9SgNBEMc9sUxxRcoUKSzSWIhXpFMhhYWFhaBg4yPYiWCXZxBLERsLRS3EQkEfwCKdjWJAwSKCgoKCcudv4O5YLrt7EzgXhiU3/4+b2ckmwVjJSpKkQ6wAi4gwhT+z3wRBcEz0yjSseUTrcRyfsHsXmD0AmbHOC9Ii8VImnuXBPglHpQ5wwSVM7sNnTG7Za4JwDdCjxyAiH3nyA2mtaTJufiDZ5dCaqlItILh1NHatfN5skvjx9Z38m69CgzuXmZgVrPIGE763Jx9qKsRozWYw6xOHdER+nn2KkO+Bb+UV5CBN6WC6QtBgbRVozrahAbmm6HtUsgtPC19tFdxXZYBOfkbmFJ1VaHA1VAHjd0pp70oTZzvR+EVrx2Ygfdsq6eu55BHYR8hlcki+n+kERUFG8BrA0BwjeAv2M8WLQBtcy+SD6fNsmnB3AlBLrgTtVW1c2QN4bVWLATaIS60J2Du5y1TiJgjSBvFVZgTmwCU+dAZFoPxGEEs8nyHC9Bwe2GvEJv2WXZb0vjdyFT4Cxk3e/kIqlOGoVLwwPevpYHT+00T+hWwXDf4AJAOUqWcDhbwAAAAASUVORK5CYII=);background-color:#31708f;color:#d9edf7;border-color:#bce8f1}.jq-icon-warning{background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAGYSURBVEhL5ZSvTsNQFMbXZGICMYGYmJhAQIJAICYQPAACiSDB8AiICQQJT4CqQEwgJvYASAQCiZiYmJhAIBATCARJy+9rTsldd8sKu1M0+dLb057v6/lbq/2rK0mS/TRNj9cWNAKPYIJII7gIxCcQ51cvqID+GIEX8ASG4B1bK5gIZFeQfoJdEXOfgX4QAQg7kH2A65yQ87lyxb27sggkAzAuFhbbg1K2kgCkB1bVwyIR9m2L7PRPIhDUIXgGtyKw575yz3lTNs6X4JXnjV+LKM/m3MydnTbtOKIjtz6VhCBq4vSm3ncdrD2lk0VgUXSVKjVDJXJzijW1RQdsU7F77He8u68koNZTz8Oz5yGa6J3H3lZ0xYgXBK2QymlWWA+RWnYhskLBv2vmE+hBMCtbA7KX5drWyRT/2JsqZ2IvfB9Y4bWDNMFbJRFmC9E74SoS0CqulwjkC0+5bpcV1CZ8NMej4pjy0U+doDQsGyo1hzVJttIjhQ7GnBtRFN1UarUlH8F3xict+HY07rEzoUGPlWcjRFRr4/gChZgc3ZL2d8oAAAAASUVORK5CYII=);background-color:#8a6d3b;color:#fcf8e3;border-color:#faebcc}.jq-icon-error{background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAHOSURBVEhLrZa/SgNBEMZzh0WKCClSCKaIYOED+AAKeQQLG8HWztLCImBrYadgIdY+gIKNYkBFSwu7CAoqCgkkoGBI/E28PdbLZmeDLgzZzcx83/zZ2SSXC1j9fr+I1Hq93g2yxH4iwM1vkoBWAdxCmpzTxfkN2RcyZNaHFIkSo10+8kgxkXIURV5HGxTmFuc75B2RfQkpxHG8aAgaAFa0tAHqYFfQ7Iwe2yhODk8+J4C7yAoRTWI3w/4klGRgR4lO7Rpn9+gvMyWp+uxFh8+H+ARlgN1nJuJuQAYvNkEnwGFck18Er4q3egEc/oO+mhLdKgRyhdNFiacC0rlOCbhNVz4H9FnAYgDBvU3QIioZlJFLJtsoHYRDfiZoUyIxqCtRpVlANq0EU4dApjrtgezPFad5S19Wgjkc0hNVnuF4HjVA6C7QrSIbylB+oZe3aHgBsqlNqKYH48jXyJKMuAbiyVJ8KzaB3eRc0pg9VwQ4niFryI68qiOi3AbjwdsfnAtk0bCjTLJKr6mrD9g8iq/S/B81hguOMlQTnVyG40wAcjnmgsCNESDrjme7wfftP4P7SP4N3CJZdvzoNyGq2c/HWOXJGsvVg+RA/k2MC/wN6I2YA2Pt8GkAAAAASUVORK5CYII=);background-color:#a94442;color:#f2dede;border-color:#ebccd1}.jq-icon-success{background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAADsSURBVEhLY2AYBfQMgf///3P8+/evAIgvA/FsIF+BavYDDWMBGroaSMMBiE8VC7AZDrIFaMFnii3AZTjUgsUUWUDA8OdAH6iQbQEhw4HyGsPEcKBXBIC4ARhex4G4BsjmweU1soIFaGg/WtoFZRIZdEvIMhxkCCjXIVsATV6gFGACs4Rsw0EGgIIH3QJYJgHSARQZDrWAB+jawzgs+Q2UO49D7jnRSRGoEFRILcdmEMWGI0cm0JJ2QpYA1RDvcmzJEWhABhD/pqrL0S0CWuABKgnRki9lLseS7g2AlqwHWQSKH4oKLrILpRGhEQCw2LiRUIa4lwAAAABJRU5ErkJggg==);color:#dff0d8;background-color:#3c763d;border-color:#d6e9c6}

web/css/light.css

@@ -2,6 +2,42 @@
     outline: 0;
 }
 
+.info-icon {
+    width: 1rem;
+    margin-right: 0.2rem;
+    cursor: pointer;
+    color: #757575;
+    line-height: 1rem;
+    height: 1rem;
+}
+
+.info-icon:hover {
+    color: inherit;
+}
+
+.modal-title {
+    max-width: calc(100% - 2rem);
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+
+.path-row {
+    display: -ms-flexbox;
+    display: flex;
+    -ms-flex-align: start;
+    align-items: flex-start;
+}
+
+.tag-container {
+    margin-left: 0.3rem;
+}
+
+.path-line {
+    color: #444;
+    text-overflow: ellipsis;
+    overflow: hidden;
+}
+
 body {
     overflow-y: scroll;
 }
@@ -16,7 +52,7 @@ body {
 }
 
 .sub-document {
-    background: #AB47BC1F;
+    background: #AB47BC1F !important;
 }
 
 .navbar-brand {
@@ -82,6 +118,9 @@ body {
 }
 
 .file-title {
+    width: 100%;
+    line-height: 1rem;
+    height: 1.1rem;
     font-size: 10pt;
     white-space: nowrap;
     text-overflow: ellipsis;
@@ -145,6 +184,7 @@ mark {
     background: #fff217;
     border-radius: 0;
     padding: 1px 0;
+    color: inherit;
 }
 
 .content-div {
@@ -248,3 +288,29 @@ mark {
     margin-top: -14px;
     font-size: 11px;
 }
+
+@media (min-width: 800px) {
+    .small-btn {
+        display: none;
+    }
+    .large-btn {
+        display: inherit;
+    }
+}
+
+@media (max-width: 801px) {
+    .small-btn {
+        display: inherit;
+    }
+    .large-btn {
+        display: none;
+    }
+}
+
+#searchBar {
+    border-right: none;
+}
+
+#pathTree .title {
+    cursor: pointer;
+}

web/js/dom.js

@@ -75,6 +75,10 @@ function shouldPlayVideo(hit) {
     return videoc !== "hevc" && videoc !== "mpeg2video" && videoc !== "wmv3";
 }
 
+function shouldDisplayRawImage(hit) {
+    return hit["_source"]["mime"] && hit["_source"]["mime"].startsWith("image/") && hit["_source"]["videoc"] !== "tiff";
+}
+
 function makePlaceholder(w, h, small) {
     let calc;
     if (small) {
@@ -96,10 +100,14 @@ function makePlaceholder(w, h, small) {
     return el;
 }
 
+function ext(hit) {
+    return hit["_source"].hasOwnProperty("extension") && hit["_source"]["extension"] !== "" ? "." + hit["_source"]["extension"] : "";
+}
+
 function makeTitle(hit) {
     let title = document.createElement("div");
     title.setAttribute("class", "file-title");
-    let extension = hit["_source"].hasOwnProperty("extension") && hit["_source"]["extension"] !== "" ? "." + hit["_source"]["extension"] : "";
+    let extension = ext(hit);
 
     applyNameToTitle(hit, title, extension);
 
@@ -113,7 +121,7 @@ function getTags(hit, mimeCategory) {
     switch (mimeCategory) {
         case "video":
         case "image":
-            if (hit["_source"].hasOwnProperty("videoc")) {
+            if (hit["_source"].hasOwnProperty("videoc") && hit["_source"]["videoc"]) {
                 const formatTag = document.createElement("span");
                 formatTag.setAttribute("class", "badge badge-pill badge-video");
                 formatTag.appendChild(document.createTextNode(hit["_source"]["videoc"].replace(" ", "")));
@@ -121,7 +129,7 @@ function getTags(hit, mimeCategory) {
             }
             break;
         case "audio": {
-            if (hit["_source"].hasOwnProperty("audioc")) {
+            if (hit["_source"].hasOwnProperty("audioc") && hit["_source"]["audioc"]) {
                 let formatTag = document.createElement("span");
                 formatTag.setAttribute("class", "badge badge-pill badge-audio");
                 formatTag.appendChild(document.createTextNode(hit["_source"]["audioc"]));
@@ -153,11 +161,44 @@ function getTags(hit, mimeCategory) {
     return tags
 }
 
-/**
- *
- * @param hit
- * @returns {Element}
- */
+function infoButtonCb(hit) {
+    return () => {
+        getDocumentInfo(hit["_id"]).then(doc => {
+            $("#modal-title").text(doc["name"] + ext(hit));
+
+            const tbody = $("<tbody>");
+            $("#modal-body").empty()
+                .append($("<table class='table table-sm'>")
+                    .append($("<thead>")
+                        .append($("<tr>")
+                            .append($("<th>").text("Field"))
+                            .append($("<th>").text("Value"))
+                        )
+                    )
+                    .append(tbody)
+                );
+
+            const displayFields = new Set([
+                "mime", "size", "mtime", "path", "title", "width", "height", "duration", "audioc", "videoc",
+                "bitrate", "artist", "album", "album_artist", "genre", "title", "font_name", "tag"
+            ]);
+            Object.keys(doc)
+                .filter(key => key.startsWith("_keyword.") || key.startsWith("_text.") || displayFields.has(key) || key.startsWith("exif_"))
+                .forEach(key => {
+                    tbody.append($("<tr>")
+                        .append($("<td>").text(key))
+                        .append($("<td>").text(doc[key]))
+                    );
+                });
+            if (doc.hasOwnProperty("content") && doc["content"]) {
+                $("#modal-body").append($("<div class='content-div'>").text(doc["content"]))
+            }
+
+            $("#modal").modal();
+        });
+    }
+}
+
 function createDocCard(hit) {
     let docCard = document.createElement("div");
     docCard.setAttribute("class", "card");
@@ -172,6 +213,7 @@ function createDocCard(hit) {
     let link = document.createElement("a");
     link.setAttribute("href", "f/" + hit["_id"]);
     link.setAttribute("target", "_blank");
+    link.style.maxWidth = "calc(100% - 1.2rem)";
     link.appendChild(title);
 
     if (hit["_source"].hasOwnProperty("parent")) {
@@ -271,7 +313,15 @@ function createDocCard(hit) {
     sizeTag.setAttribute("class", "text-muted");
     tagContainer.appendChild(sizeTag);
 
-    docCardBody.appendChild(link);
+    const titleWrapper = document.createElement("div");
+    titleWrapper.style.display = "flex";
+
+    const infoButton = makeInfoButton(hit);
+
+    titleWrapper.appendChild(infoButton);
+    titleWrapper.appendChild(link);
+
+    docCardBody.appendChild(titleWrapper);
     docCard.appendChild(docCardBody);
 
     docCardBody.appendChild(tagContainer);
@@ -327,6 +377,7 @@ function makeThumbnail(mimeCategory, hit, imgWrapper, small) {
         || hit["_source"]["mime"] === "application/pdf"
         || hit["_source"]["mime"] === "application/epub+zip"
         || hit["_source"]["mime"] === "application/x-cbz"
+        || hit["_source"]["mime"] === "application/x-cbr"
         || hit["_source"].hasOwnProperty("font_name")
     ) {
         thumbnail = document.createElement("img");
@@ -337,6 +388,15 @@ function makeThumbnail(mimeCategory, hit, imgWrapper, small) {
         }
         thumbnail.setAttribute("src", `t/${hit["_source"]["index"]}/${hit["_id"]}`);
 
+        if (!hit["_source"]["parent"] && shouldDisplayRawImage(hit)) {
+            imgWrapper.setAttribute("id", "sp" + hit["_id"]);
+            imgWrapper.setAttribute("data-src", `t/${hit["_source"]["index"]}/${hit["_id"]}`);
+            imgWrapper.setAttribute("href", `f/${hit["_id"]}`);
+            imgWrapper.setAttribute("data-caption", hit["_source"]["path"] + "/" + hit["_source"]["name"] + ext(hit));
+            imgWrapper.setAttribute("data-group", "p" + Math.floor(docCount / SIZE));
+            imgWrapper.classList.add("sp");
+        }
+
         const placeholder = makePlaceholder(hit["_source"]["width"], hit["_source"]["height"], small);
         imgWrapper.appendChild(placeholder);
 
@@ -352,6 +412,14 @@ function makeThumbnail(mimeCategory, hit, imgWrapper, small) {
     return thumbnail;
 }
 
+function makeInfoButton(hit) {
+    const infoButton = document.createElement("span");
+    infoButton.appendChild(document.createTextNode("🛈"));
+    infoButton.setAttribute("class", "info-icon");
+    infoButton.addEventListener("click", infoButtonCb(hit));
+    return infoButton;
+}
+
 function createDocLine(hit) {
 
     const mime = hit["_source"]["mime"];
@@ -367,6 +435,12 @@ function createDocLine(hit) {
     const line = document.createElement("div");
     line.setAttribute("class", "list-group-item flex-column align-items-start");
 
+    if (hit["_source"].hasOwnProperty("parent")) {
+        line.classList.add("sub-document");
+        isSubDocument = true;
+    }
+
+    const infoButton = makeInfoButton(hit);
 
     const title = makeTitle(hit);
 
@@ -376,8 +450,13 @@ function createDocLine(hit) {
     link.appendChild(title);
 
     const titleDiv = document.createElement("div");
-    titleDiv.setAttribute("class", "file-title");
-    titleDiv.appendChild(link);
+
+    const titleWrapper = document.createElement("div");
+    titleWrapper.style.display = "flex";
+    titleWrapper.appendChild(infoButton);
+    titleWrapper.appendChild(link);
+
+    titleDiv.appendChild(titleWrapper);
 
     line.appendChild(media);
 
@@ -396,8 +475,16 @@ function createDocLine(hit) {
         titleDiv.appendChild(contentDiv);
     }
 
+    let pathLine = document.createElement("div");
+    pathLine.setAttribute("class", "path-row");
+
+    let path = document.createElement("div");
+    path.setAttribute("class", "path-line");
+    path.setAttribute("title", hit["_source"]["path"] + "/");
+    path.appendChild(document.createTextNode(hit["_source"]["path"] + "/"));
+
     let tagContainer = document.createElement("div");
-    tagContainer.setAttribute("class", "");
+    tagContainer.setAttribute("class", "tag-container");
 
     for (let i = 0; i < tags.length; i++) {
         tagContainer.appendChild(tags[i]);
@@ -409,7 +496,9 @@ function createDocLine(hit) {
     sizeTag.setAttribute("class", "text-muted");
     tagContainer.appendChild(sizeTag);
 
-    titleDiv.appendChild(tagContainer);
+    titleDiv.appendChild(pathLine);
+    pathLine.appendChild(path);
+    pathLine.appendChild(tagContainer);
 
     return line;
 }
@@ -428,8 +517,7 @@ function makePreloader() {
 function makePageIndicator(searchResult) {
     let pageIndicator = document.createElement("div");
     pageIndicator.setAttribute("class", "page-indicator font-weight-light");
-    const totalHits = searchResult["hits"]["total"].hasOwnProperty("value")
-        ? searchResult["hits"]["total"]["value"] : searchResult["hits"]["total"];
+    const totalHits = searchResult["aggregations"]["total_count"]["value"];
     pageIndicator.appendChild(document.createTextNode(docCount + " / " + totalHits));
     return pageIndicator;
 }
@@ -458,26 +546,29 @@ function makeStatsCard(searchResult) {
     resultMode.appendChild(gridMode);
     resultMode.appendChild(listMode);
 
-    if (mode === "grid") {
+    if (CONF.options.display === "grid") {
         gridMode.classList.add("active")
     } else {
         listMode.classList.add("active")
     }
 
     gridMode.addEventListener("click", () => {
-        mode = "grid";
-        localStorage.setItem("mode", mode);
+        console.log("what");
+        console.log(CONF.options);
+        CONF.options.display = "grid";
+        console.log(CONF.options);
+        CONF.save();
+        console.log(CONF.options);
         searchDebounced();
     });
     listMode.addEventListener("click", () => {
-        mode = "list";
-        localStorage.setItem("mode", mode);
+        CONF.options.display = "list";
+        CONF.save();
         searchDebounced();
     });
 
     let stat = document.createElement("span");
-    const totalHits = searchResult["hits"]["total"].hasOwnProperty("value")
-        ? searchResult["hits"]["total"]["value"] : searchResult["hits"]["total"];
+    const totalHits = searchResult["aggregations"]["total_count"]["value"];
     stat.appendChild(document.createTextNode(totalHits + " results in " + searchResult["took"] + "ms"));
 
     statsCardBody.appendChild(stat);
@@ -497,7 +588,7 @@ function makeStatsCard(searchResult) {
 function makeResultContainer() {
     let resultContainer = document.createElement("div");
 
-    if (mode === "grid") {
+    if (CONF.options.display === "grid") {
         resultContainer.setAttribute("class", "card-columns");
     } else {
         resultContainer.setAttribute("class", "list-group");

web/js/search.js

@@ -6,17 +6,58 @@ let tagTree;
 
 let searchBar = document.getElementById("searchBar");
 let pathBar = document.getElementById("pathBar");
-let scroll_id = null;
+let lastDoc = null;
+let reachedEnd = false;
 let docCount = 0;
 let coolingDown = false;
 let searchBusy = true;
 let selectedIndices = [];
+let indexMap = {};
 
-let mode;
-if (localStorage.getItem("mode") === null) {
-    mode = "grid";
-} else {
-    mode = localStorage.getItem("mode")
+const CONF = new Settings();
+
+const _defaults = {
+    display: "grid",
+    fuzzy: true,
+    highlight: true
+};
+
+function Settings() {
+    this.options = {};
+
+    this._onUpdate = function () {
+        $("#fuzzyToggle").prop("checked", this.options.fuzzy);
+    }
+
+    this.load = function () {
+        const raw = window.localStorage.getItem("options");
+        if (raw === null) {
+            this.options = _defaults;
+        } else {
+            this.options = JSON.parse(raw);
+        }
+
+        this._onUpdate();
+    }
+
+    this.save = function () {
+        window.localStorage.setItem("options", JSON.stringify(this.options));
+        this._onUpdate();
+    }
+}
+
+
+function showEsError() {
+    $.toast({
+        heading: "Elasticsearch connection error",
+        text: "sist2 web module encountered an error while connecting " +
+            "to Elasticsearch. See server logs for more information.",
+        stack: false,
+        bgColor: "#a94442",
+        textColor: "#f2dede",
+        position: 'bottom-right',
+        hideAfter: false
+    });
 }
 
 jQuery["jsonPost"] = function (url, data) {
@@ -26,6 +67,7 @@ jQuery["jsonPost"] = function (url, data) {
         data: JSON.stringify(data),
         contentType: "application/json"
     }).fail(err => {
+        showEsError();
         console.log(err);
     });
 };
@@ -39,6 +81,7 @@ window.onload = () => {
         }
         window.location.reload();
     })
+    CONF.load();
 };
 
 function toggleFuzzy() {
@@ -46,19 +89,37 @@ function toggleFuzzy() {
 }
 
 $.jsonPost("i").then(resp => {
+
+    const urlIndices = (new URLSearchParams(location.search)).get("i");
     resp["indices"].forEach(idx => {
+        indexMap[idx.id] = idx.name;
         const opt = $("<option>")
             .attr("value", idx.id)
             .append(idx.name);
-        if (!idx.name.includes("(nsfw)")) {
-            opt.attr("selected", !idx.name.includes("(nsfw)"));
+
+        if (urlIndices) {
+            if (urlIndices.split(",").indexOf(idx.name) !== -1) {
+                opt.attr("selected", true);
+                selectedIndices.push(idx.id);
+            }
+        } else if (!idx.name.includes("(nsfw)")) {
+            opt.attr("selected", true);
             selectedIndices.push(idx.id);
         }
         $("#indices").append(opt);
     });
+
+    createPathTree("#pathTree");
 });
 
-function handleTreeClick (tree) {
+function getDocumentInfo(id) {
+    return $.getJSON("d/" + id).fail(e => {
+        console.log(e);
+        showEsError();
+    })
+}
+
+function handleTreeClick(tree) {
     return (event, node, handler) => {
         event.preventTreeDefault();
 
@@ -75,6 +136,7 @@ function handleTreeClick (tree) {
     }
 }
 
+//TODO: filter based on selected indexes, sort mime types
 $.jsonPost("es", {
     aggs: {
         mimeTypes: {
@@ -121,15 +183,10 @@ $.jsonPost("es", {
         target: '#mimeTree'
     });
     mimeTree.on("node.click", handleTreeClick(mimeTree));
-    mimeTree.select();
-    mimeTree.node("any").deselect();
+    mimeTree.deselect();
+    mimeTree.node("any").select();
 });
 
-function leafTag(tag) {
-    const tokens = tag.split(".");
-    return tokens[tokens.length-1]
-}
-
 // Tags tree
 $.jsonPost("es", {
     aggs: {
@@ -145,8 +202,8 @@ $.jsonPost("es", {
     resp["aggregations"]["tags"]["buckets"]
         .sort((a, b) => a["key"].localeCompare(b["key"]))
         .forEach(bucket => {
-        addTag(tagMap, bucket["key"], bucket["key"], bucket["doc_count"])
-    });
+            addTag(tagMap, bucket["key"], bucket["key"], bucket["doc_count"])
+        });
 
     tagMap.push({"text": "All", "id": "any"});
     tagTree = new InspireTree({
@@ -191,35 +248,10 @@ function addTag(map, tag, id, count) {
     }
 }
 
-new autoComplete({
-    selector: '#pathBar',
-    minChars: 1,
-    delay: 400,
-    renderItem: function (item) {
-        return '<div class="autocomplete-suggestion" data-val="' + item + '">' + item + '</div>';
-    },
-    source: async function (term, suggest) {
-        term = term.toLowerCase();
-
-        const choices = await getPathChoices();
-
-        let matches = [];
-        for (let i = 0; i < choices.length; i++) {
-            if (~choices[i].toLowerCase().indexOf(term)) {
-                matches.push(choices[i]);
-            }
-        }
-        suggest(matches);
-    },
-    onSelect: function () {
-        searchDebounced();
-    }
-});
-
 function insertHits(resultContainer, hits) {
     for (let i = 0; i < hits.length; i++) {
 
-        if (mode === "grid") {
+        if (CONF.options.display === "grid") {
             resultContainer.appendChild(createDocCard(hits[i]));
         } else {
             resultContainer.appendChild(createDocLine(hits[i]));
@@ -229,41 +261,18 @@ function insertHits(resultContainer, hits) {
 }
 
 window.addEventListener("scroll", function () {
-    if (!coolingDown && !searchBusy) {
+    if (!searchBusy) {
         let threshold = 400;
 
         if ((window.innerHeight + window.scrollY) >= document.body.offsetHeight - threshold) {
-            coolingDown = true;
-            doScroll();
+            if (!reachedEnd) {
+                coolingDown = true;
+                search(lastDoc);
+            }
         }
     }
 });
 
-function doScroll() {
-    $.get("scroll", {scroll_id: scroll_id})
-        .then(searchResult => {
-            let searchResults = document.getElementById("searchResults");
-            let hits = searchResult["hits"]["hits"];
-
-            //Page indicator
-            let pageIndicator = makePageIndicator(searchResult);
-            searchResults.appendChild(pageIndicator);
-
-            //Result container
-            let resultContainer = makeResultContainer();
-            searchResults.appendChild(resultContainer);
-
-            insertHits(resultContainer, hits);
-
-            if (hits.length === SIZE) {
-                coolingDown = false;
-            }
-        })
-        .fail(() => {
-            window.location.reload();
-        })
-}
-
 function getSelectedNodes(tree) {
     let selectedNodes = [];
 
@@ -284,21 +293,25 @@ function getSelectedNodes(tree) {
     return selectedNodes
 }
 
-function search() {
+function search(after = null) {
+    lastDoc = null;
+
     if (searchBusy) {
         return;
     }
     searchBusy = true;
 
-    //Clear old search results
     let searchResults = document.getElementById("searchResults");
-    while (searchResults.firstChild) {
-        searchResults.removeChild(searchResults.firstChild);
+    //Clear old search results
+    let preload;
+    if (!after) {
+        while (searchResults.firstChild) {
+            searchResults.removeChild(searchResults.firstChild);
+        }
+        preload = makePreloader();
+        searchResults.appendChild(preload);
     }
 
-    const preload = makePreloader();
-    searchResults.appendChild(preload);
-
     let query = searchBar.value;
     let empty = query === "";
     let condition = empty ? "should" : "must";
@@ -332,27 +345,40 @@ function search() {
         filters.push([{terms: {"tag": tags}}]);
     }
 
-    $.jsonPost("es?scroll=1", {
+    let q = {
         "_source": {
-            excludes: ["content"]
+            excludes: ["content", "_tie"]
         },
         query: {
             bool: {
                 [condition]: {
-                    multi_match: {
+                    simple_query_string: {
                         query: query,
-                        type: "most_fields",
                         fields: fields,
-                        operator: "and"
+                        default_operator: "and"
                     }
                 },
                 filter: filters
             }
         },
-        sort: [
-            "_score"
+        "sort": [
+            {"_score": {"order": "desc"}},
+            {"_tie": {"order": "asc"}}
         ],
-        highlight: {
+        aggs:
+            {
+                total_size: {"sum": {"field": "size"}},
+                total_count: {"value_count": {"field": "size"}}
+            },
+        size: SIZE,
+    };
+
+    if (after) {
+        q.search_after = [after["_score"], after["_id"]];
+    }
+
+    if (CONF.options.highlight) {
+        q.highlight = {
             pre_tags: ["<mark>"],
             post_tags: ["</mark>"],
             fields: {
@@ -362,25 +388,36 @@ function search() {
                 "name.nGram": {},
                 font_name: {},
             }
-        },
-        aggs: {
-            total_size: {"sum": {"field": "size"}}
-        },
-        size: SIZE,
-    }).then(searchResult => {
-        scroll_id = searchResult["_scroll_id"];
+        };
+    }
 
-        preload.remove();
-        //Search stats
-        searchResults.appendChild(makeStatsCard(searchResult));
+    $.jsonPost("es", q).then(searchResult => {
+        let hits = searchResult["hits"]["hits"];
+        if (hits) {
+            lastDoc = hits[hits.length - 1];
+        }
+
+        if (!after) {
+            preload.remove();
+            searchResults.appendChild(makeStatsCard(searchResult));
+        } else {
+            let pageIndicator = makePageIndicator(searchResult);
+            searchResults.appendChild(pageIndicator);
+        }
 
         //Setup page
         let resultContainer = makeResultContainer();
         searchResults.appendChild(resultContainer);
 
-        docCount = 0;
-        insertHits(resultContainer, searchResult["hits"]["hits"]);
+        window.setTimeout(() => {
+            $(".sp").SmartPhoto({animationSpeed: 0, swipeTopToClose: true, showAnimation: false, forceInterval: 50});
+        }, 100);
 
+        if (!after) {
+            docCount = 0;
+        }
+        reachedEnd = hits.length !== SIZE;
+        insertHits(resultContainer, hits);
         searchBusy = false;
     });
 }
@@ -441,21 +478,136 @@ function updateIndices() {
 document.getElementById("indices").addEventListener("change", updateIndices);
 updateIndices();
 
-//Suggest
-function getPathChoices() {
-    return new Promise(getPaths => {
-        $.jsonPost("es", {
-            suggest: {
-                path: {
-                    prefix: pathBar.value,
-                    completion: {
-                        field: "suggest-path",
-                        skip_duplicates: true,
-                        size: 10000
-                    }
+window.onkeyup = function (e) {
+    if (e.key === "/" || e.key === "Escape") {
+        const bar = document.getElementById("searchBar");
+        bar.scrollIntoView();
+        bar.focus();
+    }
+};
+
+function getNextDepth(node) {
+    let q = {
+        query: {
+            bool: {
+                filter: [
+                    {term: {index: node.index}},
+                    {term: {_depth: node.depth + 1}}
+                ]
+            }
+        },
+        aggs: {
+            paths: {
+                terms: {
+                    field: "path",
+                    size: 10000
                 }
             }
-        }).then(resp => getPaths(resp["suggest"]["path"][0]["options"].map(opt => opt["_source"]["path"])));
+        },
+        size: 0
+    }
+
+    if (node.depth > 0) {
+        q.query.bool.must = {
+            prefix: {
+                path: node.id,
+            }
+        };
+    }
+
+    return $.jsonPost("es", q).then(resp => {
+        const buckets = resp["aggregations"]["paths"]["buckets"];
+        if (!buckets) {
+            return false;
+        }
+        return buckets
+            .filter(bucket => bucket.key.length > node.id.length || node.id.startsWith("/"))
+            .sort((a, b) => a.key > b.key)
+            .map(bucket => {
+                const i = bucket.key.lastIndexOf("/");
+                const name = (i === -1 || i === 1) ? bucket.key : bucket.key.slice(i + 1);
+
+                return {
+                    id: bucket.key,
+                    text: `${name}/ (${bucket.doc_count})`,
+                    depth: node.depth + 1,
+                    index: node.index,
+                    children: true,
+                }
+            })
     })
 }
 
+function handlePathTreeClick(tree) {
+    return (event, node, handler) => {
+
+        if (node.depth !== 0) {
+            $("#pathBar").val(node.id)
+            $("#pathTreeModal").modal("hide")
+            searchDebounced();
+        }
+
+        handler();
+    }
+}
+
+function createPathTree(target) {
+    let pathTree = new InspireTree({
+        data: function (node, resolve, reject) {
+            return getNextDepth(node);
+        }
+    });
+
+    selectedIndices.forEach(index => {
+        pathTree.addNode({
+            id: "/" + index,
+            text: `/[${indexMap[index]}]`,
+            index: index,
+            depth: 0,
+            children: true
+        })
+    })
+
+    new InspireTreeDOM(pathTree, {
+        target: target
+    });
+
+    pathTree.on("node.click", handlePathTreeClick(pathTree));
+
+    const button = document.querySelector("#pathBarHelper")
+    const tooltip = document.querySelector("#pathTreeTooltip")
+    console.log(button)
+    console.log(tooltip)
+    Popper.createPopper(button, tooltip ,{
+        trigger: "click",
+        placement: "right",
+    });
+}
+
+function updateSettings() {
+    CONF.options.display = $("#settingDisplay").val();
+    CONF.options.fuzzy = $("#settingFuzzy").prop("checked");
+    CONF.options.highlight = $("#settingHighlight").prop("checked");
+    CONF.save();
+
+    searchDebounced();
+
+    $.toast({
+        heading: "Settings updated",
+        text: "Settings saved to browser storage",
+        stack: 3,
+        bgColor: "#00a4bc",
+        textColor: "#fff",
+        position: 'bottom-right',
+        hideAfter: 3000,
+        loaderBg: "#08c7e8",
+    });
+}
+
+function loadSettings() {
+    CONF.load();
+
+    $("#settingDisplay").val(CONF.options.display);
+    $("#settingFuzzy").prop("checked", CONF.options.fuzzy);
+    $("#settingHighlight").prop("checked", CONF.options.highlight);
+}

web/search.html

@@ -11,27 +11,44 @@
 
 <nav class="navbar navbar-expand-lg">
     <a class="navbar-brand" href="/">sist2</a>
-    <span class="badge badge-pill version">v1.1.11</span>
+    <span class="badge badge-pill version">v1.3.0</span>
     <span class="tagline">Lightning-fast file system indexer and search tool </span>
-    <a style="margin-left: auto" id="theme" class="btn" title="Toggle theme" href="/">Theme</a>
+    <button style="margin-left: auto" class="btn" type="button" data-toggle="modal" data-target="#settings" onclick="loadSettings()">Settings</button>
+    <a id="theme" class="btn" title="Toggle theme" href="/">Theme</a>
 </nav>
 
 <div class="container">
     <div class="card">
         <div class="card-body">
+
             <div class="form-group">
-                <input id="pathBar" type="search" class="form-control" placeholder="Filter path">
+                <div class="input-group">
+                    <div class="input-group-prepend">
+                        <button id="pathBarHelper" class="btn btn-outline-secondary" data-toggle="modal" data-target="#pathTreeModal">
+                            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512" width="20px"><path d="M288 224h224a32 32 0 0 0 32-32V64a32 32 0 0 0-32-32H400L368 0h-80a32 32 0 0 0-32 32v64H64V8a8 8 0 0 0-8-8H40a8 8 0 0 0-8 8v392a16 16 0 0 0 16 16h208v64a32 32 0 0 0 32 32h224a32 32 0 0 0 32-32V352a32 32 0 0 0-32-32H400l-32-32h-80a32 32 0 0 0-32 32v64H64V128h192v64a32 32 0 0 0 32 32zm0 96h66.74l32 32H512v128H288zm0-288h66.74l32 32H512v128H288z"/></svg>
+                        </button>
+                    </div>
+                    <input id="pathBar" type="search" class="form-control" placeholder="Filter path">
+                </div>
             </div>
+
             <div class="input-group">
                 <div class="input-group-prepend">
                     <div class="input-group-text">
-                        <span title="Toggle fuzzy searching"  onclick="document.getElementById('fuzzyToggle').click()">Fuzzy&nbsp</span>
+                        <span title="Toggle fuzzy searching" onclick="document.getElementById('fuzzyToggle').click()">Fuzzy&nbsp</span>
                         <input title="Toggle fuzzy searching" type="checkbox" id="fuzzyToggle"
                                onclick="toggleFuzzy()" checked>
                     </div>
                 </div>
                 <input id="searchBar" type="search" class="form-control" placeholder="Search">
-
+                <div class="input-group-append">
+                    <button class="btn btn-outline-secondary small-btn" type="button" data-toggle="modal"
+                            data-target="#help">?
+                    </button>
+                    <button class="btn btn-outline-secondary large-btn" type="button" data-toggle="modal"
+                            data-target="#help">Help
+                    </button>
+                </div>
             </div>
 
             <input title="File size" id="sizeSlider" name="size">
@@ -45,10 +62,12 @@
                 <div class="col" id="treeTabs">
                     <ul class="nav nav-tabs" role="tablist">
                         <li class="nav-item">
-                            <a class="nav-link active" data-toggle="tab" href="#mime" role="tab" aria-controls="home" aria-selected="true">Mime Types</a>
+                            <a class="nav-link active" data-toggle="tab" href="#mime" role="tab" aria-controls="home"
+                               aria-selected="true">Mime Types</a>
                         </li>
                         <li class="nav-item">
-                            <a class="nav-link" data-toggle="tab" href="#tag" role="tab" aria-controls="profile" aria-selected="false" title="User-defined tags">Tags</a>
+                            <a class="nav-link" data-toggle="tab" href="#tag" role="tab" aria-controls="profile"
+                               aria-selected="false" title="User-defined tags">Tags</a>
                         </li>
                     </ul>
                     <div class="tab-content" id="myTabContent">
@@ -65,6 +84,132 @@
         </div>
     </div>
 
+    <div class="modal" id="modal" tabindex="-1" role="dialog" aria-labelledby="modal-title" aria-hidden="true">
+        <div class="modal-dialog modal-lg modal-dialog-centered" role="document">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <h5 class="modal-title" id="modal-title"></h5>
+                    <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+                        <span aria-hidden="true">&times;</span>
+                    </button>
+                </div>
+                <div class="modal-body" id="modal-body"></div>
+            </div>
+        </div>
+    </div>
+
+    <div class="modal" id="help" tabindex="-1" role="dialog" aria-labelledby="modal-title" aria-hidden="true">
+        <div class="modal-dialog modal-lg modal-dialog-centered" role="document">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <h5 class="modal-title">Search help</h5>
+                    <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+                        <span aria-hidden="true">&times;</span>
+                    </button>
+                </div>
+                <div class="modal-body">
+
+                    <table class="table">
+                        <tbody>
+                        <tr>
+                            <td><code>+</code></td>
+                            <td>signifies AND operation</td>
+                        </tr>
+                        <tr>
+                            <td><code>|</code></td>
+                            <td>signifies OR operation</td>
+                        </tr>
+                        <tr>
+                            <td><code>-</code></td>
+                            <td>negates a single token</td>
+                        </tr>
+                        <tr>
+                            <td><code>""</code></td>
+                            <td>wraps a number of tokens to signify a phrase for searching</td>
+                        </tr>
+                        <tr>
+                            <td><code>*</code></td>
+                            <td>at the end of a term signifies a prefix query</td>
+                        </tr>
+                        <tr>
+                            <td><code>(</code> and <code>)</code></td>
+                            <td>signify precedence</td>
+                        </tr>
+                        <tr>
+                            <td><code>~N</code></td>
+                            <td>after a word signifies edit distance (fuzziness)</td>
+                        </tr>
+                        <tr>
+                            <td><code>~N</code></td>
+                            <td>after a phrase signifies slop amount</td>
+                        </tr>
+                        </tbody>
+                    </table>
+
+                    <p>For example: <code>"fried eggs" +(eggplant | potato) -frittata</code> will match the phrase
+                        <i>fried eggs</i> and either <i>eggplant</i> or <i>potato</i>, but will ignore results
+                        containing <i>frittata</i>.</p>
+
+                    <p>When neither <code>+</code> or <code>|</code> is specified, the default operator is <code>+</code> (and).</p>
+                    <p>When the <b>Fuzzy</b> option is checked, partial matches are also returned.</p>
+                    <br>
+                    <p>For more information, see <a target="_blank"
+                                                    href="//www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html">Elasticsearch
+                        documentation</a></p>
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div class="modal" id="settings" tabindex="-1" role="dialog" aria-labelledby="modal-title" aria-hidden="true">
+        <div class="modal-dialog modal-dialog-centered" role="document">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <h5 class="modal-title">Settings</h5>
+                    <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+                        <span aria-hidden="true">&times;</span>
+                    </button>
+                </div>
+                <div class="modal-body">
+                    <div class="custom-control custom-checkbox">
+                        <input type="checkbox" class="custom-control-input" id="settingHighlight">
+                        <label class="custom-control-label" for="settingHighlight">Enable highlighting</label>
+                    </div>
+
+                    <div class="custom-control custom-checkbox">
+                        <input type="checkbox" class="custom-control-input" id="settingFuzzy">
+                        <label class="custom-control-label" for="settingFuzzy">Set fuzzy search by default</label>
+                    </div>
+
+                    <label for="settingDisplay">Display</label>
+                    <select id="settingDisplay" class="form-control form-control-sm">
+                        <option value="grid">Grid</option>
+                        <option value="list">List</option>
+                    </select>
+
+                    <br>
+                    <button style="float: right" class="btn btn-primary" onclick="updateSettings()">Update settings</button>
+                </div>
+            </div>
+        </div>
+    </div>
+
+    <div class="modal" id="pathTreeModal" tabindex="-1" role="dialog" aria-labelledby="modal-title" aria-hidden="true">
+        <div class="modal-dialog modal-lg" role="document">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <h5 class="modal-title">Select path</h5>
+                    <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+                        <span aria-hidden="true">&times;</span>
+                    </button>
+                </div>
+                <div class="modal-body">
+                    <div id="pathTree" class="tree"></div>
+                </div>
+            </div>
+        </div>
+    </div>
+
     <div id="searchResults"></div>
 </div>