A deep dive into StructrAdvanced Topics

• Indexing

• Transaction Handling

• Periodic Task Scheduler

• Maintenance Commands

• Changelog

• Backup Options

• Events

• Java-Logging

Indexing

Passive Indexing

Periodic Task Scheduler

<methodName>.cronExpression = <s> <m> <h> <dom> <m> <dow>

Full Example

# CronService is included in the configured.services setting (and thus active)
configured.services = NodeService SchemaService HttpService CronService

# three global schema method names are registered as tasks
CronService.tasks = cleanUpMethod1 cleanUpMethod2 exampleMethod

# Run every 30 minutes
cleanUpMethod1.cronExpression = 0 0,30 * * * *

# Run every 15 minutes
cleanUpMethod2.cronExpression = 0 */15 * * * *

# Run each hour on Mondays during the first 10 days in April and October
exampleMethod.cronExpression = 0 0 * 1-10 4,10 1

Considerations

Maintenance Commands

Examples

$.maintenance('rebuildIndex', {
    "type": "Page"
});

POST /structr/rest/maintenance/rebuildIndex
{
    "type": "Page"
}

Mode set to 'AdminShell'. Type 'help' to get a list of commands.
admin@Structr> init node index for Page
Starting (re-)indexing all nodes of type Page
RebuildNodeIndex: 1 objects processed
RebuildNodeIndex: 1 objects processed
Done with (re-)indexing 1 nodes
admin@Structr>

Available Commands

changeNodePropertyKey

Parameters

clearDatabase

copyRelationshipProperties

Parameters

createLabels

Parameters

deploy

Parameters

deployData

Parameters

directFileImport

Parameters

fixNodeProperties

Parameters

flushCaches

letsencrypt

Parameters

maintenanceMode

Parameters

rebuildIndex

Parameters

rebuildIndexForType

Parameters

setNodeProperties

Parameters

setRelationshipProperties

Parameters

setUuid

Parameters

snapshot

Parameters

sync

Parameters

Changelog

Example

{"time":1455195862431,"userId":"f02e59a47d[...]","userName":"admin","verb":"change","key":"name","prev":null,"val":"My new name"}
{"time":1455195903852,"userId":"f02e59a47d[...]","userName":"admin","verb":"change","key":"name","prev":"My new name","val":"New Name"}
{"time":1455196049579,"userId":"f02e59a47d[...]","userName":"admin","verb":"link","rel":"has","relId":"97d26b5778[...]026eb615e","relDir":"out","target":"4e32a9f6eb[...]bd7a6a"}
{"time":1455195961348,"userId":"f02e59a47d[...]","userName":"admin","verb":"unlink","rel":"has","relId":"97d26b5778[...]026eb615e","relDir":"out","target":"4e32a9f6eb[...]bd7a6a"}
{"time":1455196115875,"userId":"00000000000000000000000000000000","userName":"superadmin","verb":"unlink","rel":"OWNS","relId":"b29e98329fb[...]864aa038","relDir":"out","target":"f02e59a47d[...]"}

Note

Backup Options

Cold backup

Structr Services Layer

SSHService

Public Key Authentication

Password Authentication

Example

$ ssh -p 8022 admin@localhost
Password authentication
Password: *****
Welcome to the Structr 3.6-SNAPSHOT 27066 202006301221 JavaScript console. Use <Shift>+<Tab> to switch modes.
admin@Structr/>

FtpService

$ lftp -p 8021 -u user1 localhost
Password:
lftp user1@localhost:~> DIR
drwx------   1              0 Jun 30 15:22 testFolder
-rw-------   1 user1             347 Jun 30 09:24 test1.txt
-rw-------   1             25 Jun 30 15:41 test2.txt
-rw-------   1              5 Jun 30 09:24 test3.txt
-rw-------   1 user1             5 Jun 30 09:24 test4.txt

$ lftp -p 8021 -u admin localhost
Password: *****
lftp admin@localhost:~> DIR
drwx------   1 admin             0 Jun 30 15:22 testFolder
-rw-------   1 user1           347 Jun 30 09:24 test1.txt
-rw-------   1 admin            25 Jun 30 09:24 test2.txt
-rw-------   1 user2             5 Jun 30 09:24 test3.txt
-rw-------   1 user1             5 Jun 30 09:24 test4.txt
lftp admin@localhost:/>

Events

Lifecycle Methods

onCreate

{
	let self = Structr.get('this');

	if (self.name === 'foo') {
		// don't allow Nodes named "foo"
		Structr.error('Type', 'name', 'name can not be "foo"!');
	} else {
		Structr.log('Node with name ' + self.name + ' has just been created.');
	}
}

afterCreate

{
	let self = Structr.get('this');

	let subject = 'Node was created!';
	let text = 'Node named ' + self.name + ' was created';

	Structr.send_html_mail('info@structr.com', 'Structr', 'user@domain.com', 'Test User', subject, text, text);
}

onSave

{
	let self          = $.get('this');
	let modifications = $.retrieve('modifications');

	if (modifications.after.name === 'foo') {
		// don't allow Nodes named "foo"
		Structr.error('Type', 'name', 'name can not be "foo"!');
	}
}

Modifications

{
	"before":{"visibleToAuthenticatedUsers":false,"visibleToPublicUsers":false},
	"after":{"visibleToAuthenticatedUsers":true,"visibleToPublicUsers":true},
	"added":{},
	"removed":{}
}

{
	"before":{"owner":null},
	"after":{"owner":null},
	"added":{},
	"removed":{"owner":"5ba37699ca8f4a8b92ded77c93629f0e"}
}

{
	"before":{"maintains":null},
	"after":{"maintains":[]},
	"added":{},
	"removed":{"maintains":["5ba37699ca8f4a8b92ded77c93629f0e"]}
}

onDelete

Global Events

onStructrLogin

{
	let user = Structr.retrieve('user');
	Structr.log(user.name + ' just logged in');
}

onStructrLogout

{
	let user = Structr.retrieve('user');
	Structr.log(user.name + ' just logged out');
}

onAcmeChallenge

Type-specific events

onDownload

{
	$.log($.this.name + ' was just downloaded');
}

onUpload

{
	$.log($.this.name + ' was just uploaded');
}

onOAuthLogin

{
$.log('User ' + $.this.name + ' just logged in via ' + $.methodParameters.provider);
$.log('User information: ', JSON.stringify($.methodParameters.userinfo, null, 2))
}

Java-Logging

logback-include.xml

XMPP

let xmppClient = $.this;
xmppClient.doJoinChat('chatRoom@conference.server.org', 'nickname', 'password');