1
0
Fork 0
mirror of https://github.com/documize/community.git synced 2025-07-24 07:39:43 +02:00

Merge pull request #82 from documize/license-key

License key
This commit is contained in:
Harvey Kandola 2017-02-24 09:41:41 -08:00 committed by GitHub
commit 844c457a51
26 changed files with 381 additions and 55 deletions

View file

@ -8,7 +8,7 @@ The mission is to bring software dev inspired features (refactoring, testing, li
## Latest version
v0.42.0
v0.43.0
## OS Support

View file

@ -16,14 +16,14 @@ const {
} = Ember;
export default Ember.Component.extend({
SMTPHostEmptyError: computed.empty('model.global.host'),
SMTPPortEmptyError: computed.empty('model.global.port'),
SMTPSenderEmptyError: computed.empty('model.global.sender'),
SMTPUserIdEmptyError: computed.empty('model.global.userid'),
SMTPPasswordEmptyError: computed.empty('model.global.password'),
SMTPHostEmptyError: computed.empty('model.smtp.host'),
SMTPPortEmptyError: computed.empty('model.smtp.port'),
SMTPSenderEmptyError: computed.empty('model.smtp.sender'),
SMTPUserIdEmptyError: computed.empty('model.smtp.userid'),
SMTPPasswordEmptyError: computed.empty('model.smtp.password'),
actions: {
save() {
saveSMTP() {
if (this.get('SMTPHostEmptyError')) {
$("#smtp-host").focus();
return;
@ -45,7 +45,12 @@ export default Ember.Component.extend({
return;
}
this.get('save')().then(() => {
this.get('saveSMTP')().then(() => {
});
},
saveLicense() {
this.get('saveLicense')().then(() => {
});
}
}

View file

@ -10,6 +10,18 @@
// https://documize.com
import Ember from 'ember';
import NotifierMixin from '../../mixins/notifier';
export default Ember.Component.extend({
const {
inject: { service }
} = Ember;
export default Ember.Component.extend(NotifierMixin, {
appMeta :service(),
didRender() {
if (this.get('appMeta').invalidLicense()) {
this.showNotification(`!! Expired or invalid license !!`);
}
}
});

View file

@ -16,9 +16,17 @@ export default Ember.Controller.extend(NotifierMixin, {
global: Ember.inject.service(),
actions: {
save() {
saveSMTP() {
if(this.get('session.isGlobalAdmin')) {
return this.get('global').saveConfig(this.model.global).then(() => {
return this.get('global').saveSMTPConfig(this.model.smtp).then(() => {
this.showNotification('Saved');
});
}
},
saveLicense() {
if(this.get('session.isGlobalAdmin')) {
return this.get('global').saveLicense(this.model.license).then(() => {
this.showNotification('Saved');
});
}

View file

@ -26,7 +26,8 @@ export default Ember.Route.extend(AuthenticatedRouteMixin, {
model() {
return RSVP.hash({
global: this.get('global').getConfig()
smtp: this.get('global').getSMTPConfig(),
license: this.get('global').getLicense()
});
},

View file

@ -1 +1 @@
{{global-settings model=model save=(action 'save')}}
{{global-settings model=model saveSMTP=(action 'saveSMTP') saveLicense=(action 'saveLicense')}}

View file

@ -27,9 +27,15 @@ export default Ember.Service.extend({
title: '',
version: '',
message: '',
edition: 'Community',
valid: true,
allowAnonymousAccess: false,
setupMode: false,
invalidLicense() {
return this.valid === false;
},
getBaseUrl(endpoint) {
return [this.get('endpoint'), endpoint].join('/');
},

View file

@ -21,10 +21,10 @@ export default Ember.Service.extend({
appMeta: service(),
store: service(),
// Returns global configuration.
getConfig() {
// Returns SMTP configuration.
getSMTPConfig() {
if(this.get('sessionService.isGlobalAdmin')) {
return this.get('ajax').request(`global`, {
return this.get('ajax').request(`global/smtp`, {
method: 'GET'
}).then((response) => {
return response;
@ -32,13 +32,36 @@ export default Ember.Service.extend({
}
},
// Saves global configuration.
saveConfig(config) {
// Saves SMTP configuration.
saveSMTPConfig(config) {
if(this.get('sessionService.isGlobalAdmin')) {
return this.get('ajax').request(`global`, {
return this.get('ajax').request(`global/smtp`, {
method: 'PUT',
data: JSON.stringify(config)
});
}
},
// Returns product license.
getLicense() {
if(this.get('sessionService.isGlobalAdmin')) {
return this.get('ajax').request(`global/license`, {
method: 'GET',
dataType: "text"
}).then((response) => {
return response;
});
}
},
// Saves product license.
saveLicense(license) {
if(this.get('sessionService.isGlobalAdmin')) {
return this.get('ajax').request(`global/license`, {
method: 'PUT',
dataType: 'text',
data: license
});
}
}
});

View file

@ -1,32 +1,48 @@
<form class="form-bordered">
<div class="form-header">
<div class="title">Global Settings</div>
<div class="tip">Settings applicable for all tenants</div>
<div class="title">Mail Server Settings</div>
<div class="tip">Used for sending email notifications</div>
</div>
<div class="input-control">
<label>SMTP Host</label>
<div class="tip">e.g. my.host.com</div>
{{focus-input id="smtp-host" type="text" value=model.global.host class=(if SMTPHostEmptyError 'error')}}
{{focus-input id="smtp-host" type="text" value=model.smtp.host class=(if SMTPHostEmptyError 'error')}}
</div>
<div class="input-control">
<label>SMTP Port</label>
<div class="tip">e.g. 587</div>
{{input id="smtp-port" type="text" value=model.global.port class=(if SMTPPortEmptyError 'error')}}
{{input id="smtp-port" type="text" value=model.smtp.port class=(if SMTPPortEmptyError 'error')}}
</div>
<div class="input-control">
<label>SMTP Sender</label>
<div class="tip">e.g. noreply@documize.com</div>
{{input id="smtp-sender" type="text" value=model.global.sender class=(if SMTPSenderEmptyError 'error')}}
{{input id="smtp-sender" type="text" value=model.smtp.sender class=(if SMTPSenderEmptyError 'error')}}
</div>
<div class="input-control">
<label>SMTP User ID</label>
<div class="tip">Your credentials</div>
{{input id="smtp-userid" type="text" value=model.global.userid class=(if SMTPUserIdEmptyError 'error')}}
{{input id="smtp-userid" type="text" value=model.smtp.userid class=(if SMTPUserIdEmptyError 'error')}}
</div>
<div class="input-control">
<label>SMTP Password</label>
<div class="tip">Your credentials</div>
{{input id="smtp-password" type="text" value=model.global.password class=(if SMTPPasswordEmptyError 'error')}}
{{input id="smtp-password" type="text" value=model.smtp.password class=(if SMTPPasswordEmptyError 'error')}}
</div>
<div class="regular-button button-blue" {{ action 'save' }}>save</div>
<div class="regular-button button-blue" {{ action 'saveSMTP' }}>save</div>
</form>
<div class="margin-top-50">
</div>
<form class="form-bordered">
<div class="form-header">
<div class="title">Optional Edition License</div>
<div class="tip">Only applies to Enterprise Edition</div>
</div>
<div class="input-control">
<label>License</label>
<div class="tip">XML format accepted</div>
{{textarea value=model.license rows="15"}}
</div>
<div class="regular-button button-blue" {{ action 'saveLicense' }}>save</div>
</form>

View file

@ -63,9 +63,22 @@ function isAjaxNotFoundError(reason) {
return false;
}
function isInvalidLicenseError(reason) {
if (typeof reason === "undefined" || typeof reason.errors === "undefined") {
return false;
}
if (reason.errors.length > 0 && reason.errors[0].status === "402") {
return true;
}
return false;
}
export default {
getSubdomain,
getAppUrl,
isAjaxAccessError,
isAjaxNotFoundError,
isInvalidLicenseError,
};

View file

@ -1,6 +1,6 @@
{
"name": "documize",
"version": "0.42.0",
"version": "0.43.0",
"description": "The Document IDE",
"private": true,
"repository": "",

View file

@ -18,8 +18,7 @@ import (
"github.com/documize/community/core/section"
_ "github.com/documize/community/embed" // the compressed front-end code and static data
_ "github.com/go-sql-driver/mysql" // the mysql driver is required behind the scenes
_ "github.com/go-sql-driver/mysql" // the mysql driver is required behind the scenes
)
func main() {

View file

@ -16,13 +16,15 @@ import (
"io/ioutil"
"net/http"
"encoding/xml"
"fmt"
"github.com/documize/community/core/api/request"
"github.com/documize/community/core/api/util"
)
// GetGlobalConfig returns installation-wide settings
func GetGlobalConfig(w http.ResponseWriter, r *http.Request) {
method := "GetGlobalConfig"
// GetSMTPConfig returns installation-wide SMTP settings
func GetSMTPConfig(w http.ResponseWriter, r *http.Request) {
method := "GetSMTPConfig"
p := request.GetPersister(r)
if !p.Context.Global {
@ -39,16 +41,16 @@ func GetGlobalConfig(w http.ResponseWriter, r *http.Request) {
json, err := json.Marshal(y)
if err != nil {
writeJSONMarshalError(w, method, "GetGlobalConfig", err)
writeJSONMarshalError(w, method, "SMTP", err)
return
}
util.WriteSuccessBytes(w, json)
}
// SaveGlobalConfig persists global configuration.
func SaveGlobalConfig(w http.ResponseWriter, r *http.Request) {
method := "SaveGlobalConfig"
// SaveSMTPConfig persists global SMTP configuration.
func SaveSMTPConfig(w http.ResponseWriter, r *http.Request) {
method := "SaveSMTPConfig"
p := request.GetPersister(r)
if !p.Context.Global {
@ -79,3 +81,98 @@ func SaveGlobalConfig(w http.ResponseWriter, r *http.Request) {
util.WriteSuccessEmptyJSON(w)
}
// GetLicense returns product license
func GetLicense(w http.ResponseWriter, r *http.Request) {
// method := "GetLicense"
p := request.GetPersister(r)
if !p.Context.Global {
writeForbiddenError(w)
return
}
// SMTP settings
config := request.ConfigString("EDITION-LICENSE", "")
if len(config) == 0 {
config = "{}"
}
x := &licenseXML{Key: "", Signature: ""}
lj := licenseJSON{}
err := json.Unmarshal([]byte(config), &lj)
if err == nil {
x.Key = lj.Key
x.Signature = lj.Signature
} else {
fmt.Println(err)
}
output, err := xml.Marshal(x)
if err != nil {
fmt.Printf("error: %v\n", err)
}
w.WriteHeader(http.StatusOK)
w.Write(output)
}
// SaveLicense persists product license
func SaveLicense(w http.ResponseWriter, r *http.Request) {
method := "SaveLicense"
p := request.GetPersister(r)
if !p.Context.Global {
writeForbiddenError(w)
return
}
defer r.Body.Close()
body, err := ioutil.ReadAll(r.Body)
if err != nil {
writePayloadError(w, method, err)
return
}
var config string
config = string(body)
lj := licenseJSON{}
x := licenseXML{Key: "", Signature: ""}
err = xml.Unmarshal([]byte(config), &x)
if err == nil {
lj.Key = x.Key
lj.Signature = x.Signature
} else {
fmt.Println(err)
}
j, err := json.Marshal(lj)
js := "{}"
if err == nil {
js = string(j)
}
request.ConfigSet("EDITION-LICENSE", js)
util.WriteSuccessEmptyJSON(w)
}
type licenseXML struct {
XMLName xml.Name `xml:"DocumizeLicense"`
Key string
Signature string
}
type licenseJSON struct {
Key string `json:"key"`
Signature string `json:"signature"`
}
/*
<DocumizeLicense>
<Key>some key</Key>
<Signature>some signature</Signature>
</DocumizeLicense>
*/

View file

@ -41,6 +41,11 @@ func writeTransactionError(w http.ResponseWriter, method string, err error) {
log.Error(fmt.Sprintf("Unable to get database transaction for method %s", method), err)
}
// IsInvalidLicense returns true if license is invalid
func IsInvalidLicense() bool {
return Product.License.Valid == false
}
/*
func WriteAddRecordError(w http.ResponseWriter, method string, err error) {
w.Header().Set("Content-Type", "application/json; charset=utf-8")

View file

@ -32,6 +32,11 @@ import (
// AddFolder creates a new folder.
func AddFolder(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "AddFolder"
p := request.GetPersister(r)
@ -263,6 +268,11 @@ func UpdateFolder(w http.ResponseWriter, r *http.Request) {
// RemoveFolder moves documents to another folder before deleting it
func RemoveFolder(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "RemoveFolder"
p := request.GetPersister(r)

View file

@ -18,7 +18,6 @@ import (
"net/http"
"text/template"
"github.com/documize/community/core"
"github.com/documize/community/core/api/entity"
"github.com/documize/community/core/api/request"
"github.com/documize/community/core/log"
@ -41,13 +40,13 @@ func GetMeta(w http.ResponseWriter, r *http.Request) {
return
}
product := core.Product()
data.OrgID = org.RefID
data.Title = org.Title
data.Message = org.Message
data.AllowAnonymousAccess = org.AllowAnonymousAccess
data.Version = product.Version
data.Version = Product.Version
data.Edition = Product.License.Edition
data.Valid = Product.License.Valid
json, err := json.Marshal(data)

View file

@ -33,6 +33,11 @@ import (
// AddDocumentPage inserts new section into document.
func AddDocumentPage(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "AddDocumentPage"
p := request.GetPersister(r)
@ -286,6 +291,11 @@ func GetDocumentPagesBatch(w http.ResponseWriter, r *http.Request) {
// DeleteDocumentPage deletes a page.
func DeleteDocumentPage(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "DeleteDocumentPage"
p := request.GetPersister(r)
@ -354,6 +364,11 @@ func DeleteDocumentPage(w http.ResponseWriter, r *http.Request) {
// DeleteDocumentPages batch deletes pages.
func DeleteDocumentPages(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "DeleteDocumentPages"
p := request.GetPersister(r)
@ -433,6 +448,11 @@ func DeleteDocumentPages(w http.ResponseWriter, r *http.Request) {
// that this is a new revision. If the page is the first in a document
// then the corresponding document title will also be changed.
func UpdateDocumentPage(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "UpdateDocumentPage"
p := request.GetPersister(r)
params := mux.Vars(r)
@ -540,6 +560,11 @@ func UpdateDocumentPage(w http.ResponseWriter, r *http.Request) {
// ChangeDocumentPageSequence will swap page sequence for a given number of pages.
func ChangeDocumentPageSequence(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "ChangeDocumentPageSequence"
p := request.GetPersister(r)
@ -598,6 +623,11 @@ func ChangeDocumentPageSequence(w http.ResponseWriter, r *http.Request) {
// ChangeDocumentPageLevel handles page indent/outdent changes.
func ChangeDocumentPageLevel(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "ChangeDocumentPageLevel"
p := request.GetPersister(r)
@ -740,6 +770,11 @@ func GetPageMoveCopyTargets(w http.ResponseWriter, r *http.Request) {
// GetDocumentRevisions returns all changes for a document.
func GetDocumentRevisions(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "GetDocumentPageRevisions"
p := request.GetPersister(r)
@ -770,6 +805,11 @@ func GetDocumentRevisions(w http.ResponseWriter, r *http.Request) {
// GetDocumentPageRevisions returns all changes for a given page.
func GetDocumentPageRevisions(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "GetDocumentPageRevisions"
p := request.GetPersister(r)
@ -807,6 +847,11 @@ func GetDocumentPageRevisions(w http.ResponseWriter, r *http.Request) {
// GetDocumentPageDiff returns HTML diff between two revisions of a given page.
func GetDocumentPageDiff(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "GetDocumentPageDiff"
p := request.GetPersister(r)

View file

@ -28,6 +28,11 @@ import (
// AddPin saves pinned item.
func AddPin(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "AddPin"
p := request.GetPersister(r)
params := mux.Vars(r)
@ -131,6 +136,11 @@ func GetUserPins(w http.ResponseWriter, r *http.Request) {
// DeleteUserPin removes saved user pin.
func DeleteUserPin(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "DeleteUserPin"
p := request.GetPersister(r)
params := mux.Vars(r)
@ -175,6 +185,11 @@ func DeleteUserPin(w http.ResponseWriter, r *http.Request) {
// UpdatePinSequence records order of pinned items.
func UpdatePinSequence(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "UpdatePinSequence"
p := request.GetPersister(r)
params := mux.Vars(r)

View file

@ -229,8 +229,10 @@ func init() {
log.IfErr(Add(RoutePrefixPrivate, "documents/{documentID}/links", []string{"GET", "OPTIONS"}, nil, GetDocumentLinks))
// Global installation-wide config
log.IfErr(Add(RoutePrefixPrivate, "global", []string{"GET", "OPTIONS"}, nil, GetGlobalConfig))
log.IfErr(Add(RoutePrefixPrivate, "global", []string{"PUT", "OPTIONS"}, nil, SaveGlobalConfig))
log.IfErr(Add(RoutePrefixPrivate, "global/smtp", []string{"GET", "OPTIONS"}, nil, GetSMTPConfig))
log.IfErr(Add(RoutePrefixPrivate, "global/smtp", []string{"PUT", "OPTIONS"}, nil, SaveSMTPConfig))
log.IfErr(Add(RoutePrefixPrivate, "global/license", []string{"GET", "OPTIONS"}, nil, GetLicense))
log.IfErr(Add(RoutePrefixPrivate, "global/license", []string{"PUT", "OPTIONS"}, nil, SaveLicense))
// Pinned items
log.IfErr(Add(RoutePrefixPrivate, "pin/{userID}", []string{"POST", "OPTIONS"}, nil, AddPin))

View file

@ -185,6 +185,11 @@ func RefreshSections(w http.ResponseWriter, r *http.Request) {
// AddBlock inserts new reusable content block into database.
func AddBlock(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "AddBlock"
p := request.GetPersister(r)

View file

@ -33,11 +33,21 @@ var port, certFile, keyFile, forcePort2SSL string
var Product core.ProdInfo
func init() {
Product = core.Product()
Product.Major = "0"
Product.Minor = "43"
Product.Patch = "0"
Product.Version = fmt.Sprintf("%s.%s.%s", Product.Major, Product.Minor, Product.Patch)
Product.Edition = "Community"
Product.Title = fmt.Sprintf("%s Edition", Product.Edition)
Product.License = core.License{}
Product.License.Valid = true
environment.GetString(&certFile, "cert", false, "the cert.pem file used for https", nil)
environment.GetString(&keyFile, "key", false, "the key.pem file used for https", nil)
environment.GetString(&port, "port", false, "http/https port number", nil)
environment.GetString(&forcePort2SSL, "forcesslport", false, "redirect given http port number to TLS", nil)
log.Info("Server.Init complete")
}
var testHost string // used during automated testing

View file

@ -36,6 +36,11 @@ import (
// SaveAsTemplate saves existing document as a template.
func SaveAsTemplate(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "SaveAsTemplate"
p := request.GetPersister(r)

View file

@ -33,6 +33,11 @@ import (
// AddUser is the endpoint that enables an administrator to add a new user for their orgaisation.
func AddUser(w http.ResponseWriter, r *http.Request) {
if IsInvalidLicense() {
util.WriteBadLicense(w)
return
}
method := "AddUser"
p := request.GetPersister(r)

View file

@ -341,6 +341,8 @@ type SiteMeta struct {
URL string `json:"url"`
AllowAnonymousAccess bool `json:"allowAnonymousAccess"`
Version string `json:"version"`
Edition string `json:"edition"`
Valid bool `json:"valid"`
}
// Template is used to create a new document.

View file

@ -164,3 +164,17 @@ func WriteJSON(w http.ResponseWriter, v interface{}) {
_, err = w.Write(j)
log.IfErr(err)
}
// WriteBadLicense writes 402 when license is invalid
func WriteBadLicense(w http.ResponseWriter) {
w.Header().Set("Content-Type", "application/json; charset=utf-8")
w.WriteHeader(http.StatusPaymentRequired)
var e struct {
Reason string
}
e.Reason = "invalid or expired Documize license"
j, _ := json.Marshal(e)
_, err := w.Write(j)
log.IfErr(err)
}

View file

@ -11,7 +11,10 @@
package core
import "fmt"
import (
"fmt"
"time"
)
// ProdInfo describes a product
type ProdInfo struct {
@ -21,16 +24,42 @@ type ProdInfo struct {
Major string
Minor string
Patch string
License License
}
// Product returns product edition details
func Product() (p ProdInfo) {
p.Major = "0"
p.Minor = "42"
p.Patch = "0"
p.Version = fmt.Sprintf("%s.%s.%s", p.Major, p.Minor, p.Patch)
p.Edition = "Community"
p.Title = fmt.Sprintf("%s Edition", p.Edition)
return p
// License holds details of product license.
type License struct {
Name string `json:"name"`
Email string `json:"email"`
Edition string `json:"edition"`
Start time.Time `json:"start"`
End time.Time `json:"end"`
Seats int `json:"seats"`
Trial bool `json:"trial"`
Valid bool
}
// IsEmpty determines if we have a license.
func (l *License) IsEmpty() bool {
return l.Seats == 0 && len(l.Name) == 0 && len(l.Email) == 0 && l.Start.Year() == 1 && l.End.Year() == 1
}
// Status returns formatted message stating if license is empty/populated and invalid/valid.
func (l *License) Status() string {
lp := "populated"
if l.IsEmpty() {
lp = "empty"
}
lv := "invalid"
if l.Valid {
lv = "valid"
}
return fmt.Sprintf("License is %s and %s", lp, lv)
}
// LicenseData holds encrypted data and is unpacked into License.
type LicenseData struct {
Key string `json:"key"`
Signature string `json:"signature"`
}