TiddlyWikiPharo/repository/TiddlyWiki/TiddlyWiki.class.st

"
I model a TiddlyWiki.
More information:

https://tiddlywiki.com/
"
Class {
	#name : #TiddlyWiki,
	#superclass : #Object,
	#instVars : [
		'name',
		'file',
		'remote',
		'jsonFile',
		'tiddlers'
	],
	#category : #'TiddlyWiki-Model'
}

{ #category : #accessing }
TiddlyWiki class >> fromJSONUrl: anUrlString [
	| rawContents contentsString |
	rawContents := anUrlString asUrl retrieveContents.
	rawContents class = ByteArray 
		ifTrue: [ contentsString := rawContents utf8Decoded ]
		ifFalse: [ contentsString := rawContents ].
	^ self new
		 fromDictionary: (STONJSON fromString: contentsString);
		 remote: anUrlString;
		 name: anUrlString
]

{ #category : #accessing }
TiddlyWiki >> addToConfigFile [
	| cleaned newConfig |
	cleaned := self copy.
	cleaned tiddlers: nil.
	newConfig := self configDictonary 
		at: cleaned name put: cleaned;
		yourself.
	^ MarkupFile exportAsFileOn: self  configFile containing:(STON toStringPretty: newConfig)
]

{ #category : #accessing }
TiddlyWiki >> changesAfter: aDate [

	| recent created modified wiki |
	wiki := self withoutImages withoutPDFs contentTiddlers.
	created := wiki select: [ :tiddler | tiddler created > aDate ].
    modified := wiki select: [ :tiddler | tiddler modified isNotNil 
    	and: [ tiddler modified > aDate ] ].
    
    recent := OrderedCollection new.
	recent 
		addAll: created; 
		addAll: modified.
	^ recent asSet.
]

{ #category : #accessing }
TiddlyWiki >> configDictonary [
	^ STONJSON fromString: self configFile contents.
]

{ #category : #accessing }
TiddlyWiki >> configFile [
	| tempFile |
	tempFile := FileLocator home / '.config' / 'TiddlyWikiPharo' / 'tiddlywiki.conf.ston'.
	tempFile ensureCreateFile.
	tempFile contents isEmpty ifTrue: [ 
		MarkupFile exportAsFileOn: tempFile containing:  ( STON toStringPretty: Dictionary new) 
	]. 
	^ tempFile
	
]

{ #category : #accessing }
TiddlyWiki >> contentTiddlers [
	^ self tiddlers copyWithoutAll: self shadow  
]

{ #category : #accessing }
TiddlyWiki >> exportJSONFile [
	| docTree rawJsonTiddlers |
	self htmlFileExists.
	docTree := XMLHTMLParser parse: self file contents.
	rawJsonTiddlers := (docTree xpath: '//script[@class="tiddlywiki-tiddler-store"]') stringValue.
	^ MarkupFile exportAsFileOn: self jsonFile containing: rawJsonTiddlers
]

{ #category : #accessing }
TiddlyWiki >> exportJSONSubtiddlers: subtiddlersCollection [
	^ MarkupFile exportAsFileOn: self file parent / 'subtiddlers.json' containing: (self jsonSubtiddlers: subtiddlersCollection) 
]

{ #category : #accessing }
TiddlyWiki >> exportSTONFiles [

	| stonFile wikiTemp shadowFile |
	self tiddlersJSONFile
		ifNil: [ 
			self inform:
				'No JSON Tiddlers file found. If you have one, please provide its location'.
			stonFile := FileLocator temp / 'tiddlers.ston' ]
		ifNotNil: [ 
		stonFile := self tiddlersJSONFile withoutExtension , 'ston' ].
	shadowFile := self shadowsFolder / '_shadow.ston'.
	wikiTemp := self copy.
	wikiTemp tiddlers: self contentTiddlers.
	wikiTemp := wikiTemp withoutImages.
	wikiTemp := wikiTemp withoutPDFs.
	GrafoscopioUtils exportAsSton: self shadow on: shadowFile.
	^ GrafoscopioUtils exportAsSton: wikiTemp on: stonFile
]

{ #category : #accessing }
TiddlyWiki >> exportSTONTiddlers: aCollection [
	aCollection do: [:each | each exportSTONFile ]
]

{ #category : #accessing }
TiddlyWiki >> file [
	^ file
]

{ #category : #accessing }
TiddlyWiki >> file: anObject [
	file := anObject
]

{ #category : #accessing }
TiddlyWiki >> fromDictionary: tiddlersDict [

	self tiddlers: (tiddlersDict collect: [ :each | 
			 Tiddler new
				 fromDictionary: each;
				 wiki: self ])
]

{ #category : #accessing }
TiddlyWiki >> fromUrl: anUrlString [
	| docTree rawJsonTiddlers tiddlersDictionary |
	self remote: anUrlString.
	docTree := XMLHTMLParser parse: (self remote retrieveContents).
	rawJsonTiddlers := (docTree xpath: '//script[@class="tiddlywiki-tiddler-store"]') stringValue.
	tiddlersDictionary := STONJSON fromString: rawJsonTiddlers.
	self fromDictionary: tiddlersDictionary
]

{ #category : #accessing }
TiddlyWiki >> htmlFileExists [
	self file ifNil: [ 
		self inform: 'No TiddlyWiki HTML file found. If you have one, please provide its location.'.
		^ nil
	].
]

{ #category : #accessing }
TiddlyWiki >> importJSONFile [

	"I import a JSON representation of my tiddlers data, that has been previosly exported 
	by the TiddlyWiki HTML self contained file.
	Such file is called, by convention, 'tiddlers.json' and stored in the same folder where
	the HTML file is located."

	| tiddlersDict |
	self tiddlersJSONFile ifNil: [ ^ self ].
	tiddlersDict := STONJSON fromString: self tiddlersJSONFile contents.
	self fromDictionary: tiddlersDict
]

{ #category : #accessing }
TiddlyWiki >> jsonFile [
	^ jsonFile ifNil: [
		self htmlFileExists.
		jsonFile := file parent / 'tiddlers.json'.]
]

{ #category : #accessing }
TiddlyWiki >> jsonFile: aFileLocator [
	"I contain the tiddlers representation of the wiki data in JSON format."
	jsonFile := aFileLocator
]

{ #category : #accessing }
TiddlyWiki >> jsonSubtiddlers: subtiddlersCollection [
	| subtiddlersDict |
	subtiddlersDict := subtiddlersCollection collect: [:tiddler | tiddler asDictionary ].
	^ STONJSON toStringPretty: subtiddlersDict
]

{ #category : #accessing }
TiddlyWiki >> loadFromConfig: wikiname [ 
	^ (self configDictonary at: wikiname) importJSONFile.
	
]

{ #category : #accessing }
TiddlyWiki >> local [
	^ self file
]

{ #category : #accessing }
TiddlyWiki >> local: aFileRefence [
	^ self file:aFileRefence 
]

{ #category : #accessing }
TiddlyWiki >> name [
	| tempName suffix  |
	name ifNotNil: [ ^ name ].
	self file ifNotNil: [ ^ name := self file basenameWithoutExtension ].
	self remote ifNil: [ ^ name := nil ].
	tempName := self remote file.
	(tempName endsWithAnyOf: #('.html' '.htm')) ifTrue: [
			suffix := (tempName splitOn: '.') last.
			tempName := tempName removeSuffix: '.', suffix.
	].
	name := tempName
]

{ #category : #accessing }
TiddlyWiki >> name: aString [

	name := aString
]

{ #category : #accessing }
TiddlyWiki >> networkView [
	| view |
	view := GtMondrian new.
	view nodes
		with: self tiddlers.
	view edges
		connectFromAll: #linkedTiddlers.
	view layout force.
	^ view
]

{ #category : #accessing }
TiddlyWiki >> printOn: aStream [
	super printOn: aStream.
	aStream
		nextPutAll: '( ', self name ,' )'
]

{ #category : #accessing }
TiddlyWiki >> remote [

	^ remote
]

{ #category : #accessing }
TiddlyWiki >> remote: aUrlString [

	remote := aUrlString asZnUrl 
]

{ #category : #accessing }
TiddlyWiki >> shadow [
	"Shadow tiddlers are tiddlers that are loaded from plugins.
	For more information about them, see:
	
	- https://tiddlywiki.com/static/ShadowTiddlers.html
	- https://groups.google.com/g/TiddlyWiki/c/HuyZmaRJTxI"
 	^ self tiddlers select: [:tiddler | tiddler title beginsWith: '$:/']
]

{ #category : #accessing }
TiddlyWiki >> shadowsFolder [
	"I store all shadow tiddlers, i.e. tiddlers that provide functionality to TiddlyWiki,
	for example the ones that come in the plugins or in system tiddlers.
	For more information about shadow tiddlers, see #shadow method."
	^ self file parent / 'shadow'
]

{ #category : #accessing }
TiddlyWiki >> taggedWith: aTag [
	^ self tiddlers select: [:tiddler | 
		tiddler tags isNotNil and: [tiddler tags includesSubstring: aTag ]
	]
]

{ #category : #accessing }
TiddlyWiki >> tiddlers [

	^ tiddlers ifNil: [ tiddlers := OrderedCollection new ]
]

{ #category : #accessing }
TiddlyWiki >> tiddlers: anOrderedCollection [

	tiddlers := anOrderedCollection
]

{ #category : #accessing }
TiddlyWiki >> tiddlersFolder [

	^ self file parent / 'tiddlers'
]

{ #category : #accessing }
TiddlyWiki >> tiddlersJSONFile [
	
	self jsonFile exists ifFalse: [ 
		self inform: 'You need to export tiddlers as JSON from TiddlyWiki and locate it in the same folder as the HTML file'. 
		^ nil
	].
	^ jsonFile  
]

{ #category : #accessing }
TiddlyWiki >> tiddlersJSONUrl [
	self remote ifNil: [^ nil].
]

{ #category : #accessing }
TiddlyWiki >> withoutContentType: application [
	| filteredTiddlers tempWiki | 
	filteredTiddlers := self tiddlers reject: [:tiddler | tiddler type isNotNil and: [tiddler type beginsWith: application]  ].
	tempWiki := self copy 
		tiddlers: filteredTiddlers.
	tempWiki tiddlers do: [:tiddler | tiddler wiki: tempWiki ].
	^ tempWiki
]

{ #category : #accessing }
TiddlyWiki >> withoutImages [
	^ self withoutContentType: 'image/'
]

{ #category : #accessing }
TiddlyWiki >> withoutPDFs [
	^ self withoutContentType: 'application/pdf'
]