restructure directories

core/convapi/convertapi.go

@@ -0,0 +1,44 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+// Package convapi provides the defininitions of types used for file conversion communication between different components of the Documize system.
+package convapi
+
+// DocumentConversionRequest is what is passed to a Convert plugin.
+type DocumentConversionRequest struct {
+	Filename       string
+	Filedata       []byte
+	PageBreakLevel uint
+	Token          string // authorisation token
+}
+
+// Page holds the contents of a Documize page,
+// which is a Body of html with a Title and a Level,
+type Page struct {
+	Level uint64 // overall document is level 1, <H1> => level 2
+	Title string
+	Body  []byte
+}
+
+// EmbeddedFile holds the contents of an embedded file.
+type EmbeddedFile struct {
+	ID, Type, Name string // name must have the same extension as the type e.g. Type="txt" Name="foo.txt"
+	Data           []byte
+}
+
+// DocumentConversionResponse is the response from a Convert plugin.
+type DocumentConversionResponse struct {
+	Err           string
+	PagesHTML     []byte // If empty, use Pages
+	Pages         []Page
+	EmbeddedFiles []EmbeddedFile
+	Excerpt       string
+}

core/convapi/request.go

@@ -0,0 +1,26 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under 
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>. 
+//
+// https://documize.com
+
+package convapi
+
+// ConversionJobRequest is the information used to set-up a conversion job.
+type ConversionJobRequest struct {
+	Job        string
+	IndexDepth uint
+	OrgID      string
+}
+
+// DocumentExport is the type used by a document export plugin.
+type DocumentExport struct {
+	Filename string
+	Format   string
+	File     []byte
+}

core/convapi/response.go

@@ -0,0 +1,90 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under 
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>. 
+//
+// https://documize.com
+
+package convapi
+
+import (
+	"github.com/documize/community/core/log"
+	"encoding/json"
+	"net/http"
+)
+
+// apiJSONResponse is the structure of a JSON response to a Documize client.
+type apiJSONResponse struct {
+	Code    int
+	Success bool
+	Message string
+	Data    interface{}
+}
+
+// SetJSONResponse sets the response type to "application/json" in the HTTP header.
+func SetJSONResponse(w http.ResponseWriter) {
+	w.Header().Set("Content-Type", "application/json; charset=utf-8")
+}
+
+// WriteError to the http.ResponseWriter, taking care to provide the correct
+// response error code within the JSON response.
+func WriteError(w http.ResponseWriter, err error) {
+
+	response := apiJSONResponse{}
+	response.Message = err.Error()
+	response.Success = false
+	response.Data = nil
+
+	switch err.Error() {
+	case "BadRequest":
+		response.Code = 400
+		w.WriteHeader(http.StatusBadRequest)
+	case "Unauthorized":
+		response.Code = 401
+		w.WriteHeader(http.StatusUnauthorized)
+	case "Forbidden":
+		response.Code = 403
+		w.WriteHeader(http.StatusForbidden)
+	case "NotFound":
+		response.Code = 404
+		w.WriteHeader(http.StatusNotFound)
+	default:
+		response.Code = 500
+		w.WriteHeader(http.StatusInternalServerError)
+	}
+
+	json, err := json.Marshal(response)
+	if err != nil {
+		log.Error("json.Marshal", err)
+	}
+
+	if _, err := w.Write(json); err != nil {
+		log.Error("write to ResponseWriter", err)
+	}
+}
+
+// WriteErrorBadRequest provides feedback to a Documize client on an error,
+// where that error is described in a string.
+func WriteErrorBadRequest(w http.ResponseWriter, message string) {
+
+	response := apiJSONResponse{}
+	response.Message = message
+	response.Success = false
+	response.Data = nil
+
+	response.Code = 400
+	w.WriteHeader(http.StatusBadRequest)
+
+	json, err := json.Marshal(response)
+	if err != nil {
+		log.Error("json.Marshal", err)
+	}
+
+	if _, err := w.Write(json); err != nil {
+		log.Error("write to ResponseWriter", err)
+	}
+}