gosuki/chrome.go

package main

import (
	"io/ioutil"
	"path"
	"time"

	"github.com/OneOfOne/xxhash"
	"github.com/buger/jsonparser"
	"github.com/fsnotify/fsnotify"
)

var ChromeData = BrowserPaths{
	BookmarkFile: "Bookmarks",
	BookmarkDir:  "/home/spike/.config/google-chrome-unstable/Default/",
}

type ChromeBrowser struct {
	BaseBrowser //embedding
}

var jsonNodeTypes = struct {
	Folder, URL string
}{"folder", "url"}

var jsonNodePaths = struct {
	Type, Children, URL string
}{"type", "children", "url"}

type ParseChildFunc func([]byte, jsonparser.ValueType, int, error)
type RecursiveParseFunc func([]byte, []byte, jsonparser.ValueType, int) error

type RawNode struct {
	name         []byte
	nType        []byte
	url          []byte
	children     []byte
	childrenType jsonparser.ValueType
}

func (rawNode *RawNode) parseItems(nodeData []byte) {

	// Paths to lookup in node payload
	paths := [][]string{
		[]string{"type"},
		[]string{"name"}, // Title of page
		[]string{"url"},
		[]string{"children"},
	}

	jsonparser.EachKey(nodeData, func(idx int, value []byte, vt jsonparser.ValueType, err error) {
		switch idx {
		case 0:
			rawNode.nType = value
			//currentNode.Type = _s(value)

		case 1: // name or title
			//currentNode.Name = _s(value)
			rawNode.name = value
		case 2:
			//currentNode.URL = _s(value)
			rawNode.url = value
		case 3:
			rawNode.children, rawNode.childrenType = value, vt
		}
	}, paths...)
}

// Returns *Node from *RawNode
func (rawNode *RawNode) getNode() *Node {
	node := new(Node)
	node.Type = _s(rawNode.nType)
	node.Name = _s(rawNode.name)

	return node
}

func NewChromeBrowser() IBrowser {
	browser := new(ChromeBrowser)
	browser.name = "chrome"
	browser.bType = TChrome
	browser.baseDir = ChromeData.BookmarkDir
	browser.bkFile = ChromeData.BookmarkFile
	browser.Stats = new(ParserStats)
	browser.NodeTree = &Node{Name: "root", Parent: nil, Type: "root"}
	browser.useFileWatcher = true

	// Across jobs buffer
	browser.InitBuffer()

	// Create watch objects, we will watch the basedir for create events
	watchedEvents := []fsnotify.Op{fsnotify.Create}
	w := &Watch{
		path:       browser.baseDir,
		eventTypes: watchedEvents,
		eventNames: []string{path.Join(browser.baseDir, browser.bkFile)},
		resetWatch: true,
	}
	browser.SetupFileWatcher(w)

	return browser
}

func (bw ChromeBrowser) Shutdown() {
	log.Debugf("<%s> shutting down ... ", bw.name)
	err := bw.BaseBrowser.Close()
	if err != nil {
		log.Error(err)
	}
}

func (bw *ChromeBrowser) Watch() bool {
	if !bw.isWatching {
		go WatcherThread(bw)
		bw.isWatching = true
		log.Infof("<%s> Watching %s", bw.name, bw.GetPath())
		return true
	}

	return false
}

func (bw *ChromeBrowser) Load() {

	// BaseBrowser load method
	bw.BaseBrowser.Load()

	bw.Run()
}

func (bw *ChromeBrowser) Run() {

	// Rebuild node tree
	bw.RebuildNodeTree()

	// Load bookmark file
	bookmarkPath := path.Join(bw.baseDir, bw.bkFile)
	f, err := ioutil.ReadFile(bookmarkPath)
	if err != nil {
		log.Critical(err)
	}

	var parseChildren ParseChildFunc
	var jsonParseRecursive RecursiveParseFunc

	parseChildren = func(childVal []byte, dataType jsonparser.ValueType, offset int, err error) {
		if err != nil {
			log.Panic(err)
		}

		jsonParseRecursive(nil, childVal, dataType, offset)
	}

	// Needed to store the parent of each child node
	var parentNodes []*Node

	jsonParseRoots := func(key []byte, node []byte, dataType jsonparser.ValueType, offset int) error {

		// If node type is string ignore (needed for sync_transaction_version)
		if dataType == jsonparser.String {
			return nil
		}

		bw.Stats.currentNodeCount++

		rawNode := new(RawNode)
		rawNode.parseItems(node)
		//log.Debugf("Parsing root folder %s", rawNode.name)

		currentNode := rawNode.getNode()

		// Process this node as parent node later
		parentNodes = append(parentNodes, currentNode)

		// add the root node as parent to this node
		currentNode.Parent = bw.NodeTree

		// Add this root node as a child of the root node
		bw.NodeTree.Children = append(bw.NodeTree.Children, currentNode)

		// Call recursive parsing of this node which must
		// a root folder node
		jsonparser.ArrayEach(node, parseChildren, jsonNodePaths.Children)

		// Finished parsing this root, it is not anymore a parent
		_, parentNodes = parentNodes[len(parentNodes)-1], parentNodes[:len(parentNodes)-1]

		//log.Debugf("Parsed root %s folder", rawNode.name)

		return nil
	}

	// Main recursive parsing function that parses underneath
	// each root folder
	jsonParseRecursive = func(key []byte, node []byte, dataType jsonparser.ValueType, offset int) error {

		// If node type is string ignore (needed for sync_transaction_version)
		if dataType == jsonparser.String {
			return nil
		}

		bw.Stats.currentNodeCount++

		rawNode := new(RawNode)
		rawNode.parseItems(node)

		currentNode := rawNode.getNode()
		//log.Debugf("parsing node %s", currentNode.Name)

		// if parents array is not empty
		if len(parentNodes) != 0 {
			parent := parentNodes[len(parentNodes)-1]
			//log.Debugf("Adding current node to parent %s", parent.Name)

			// Add current node to closest parent
			currentNode.Parent = parent

			// Add current node as child to parent
			currentNode.Parent.Children = append(currentNode.Parent.Children, currentNode)
		}

		// if node is a folder with children
		if rawNode.childrenType == jsonparser.Array && len(rawNode.children) > 2 { // if len(children) > len("[]")

			//log.Debugf("Started folder %s", rawNode.name)
			parentNodes = append(parentNodes, currentNode)

			// Process recursively all child nodes of this folder node
			jsonparser.ArrayEach(node, parseChildren, jsonNodePaths.Children)

			//log.Debugf("Finished folder %s", rawNode.name)
			_, parentNodes = parentNodes[len(parentNodes)-1], parentNodes[:len(parentNodes)-1]

		}

		// if node is url(leaf), handle the url
		if _s(rawNode.nType) == jsonNodeTypes.URL {

			currentNode.URL = _s(rawNode.url)

			bw.Stats.currentUrlCount++

			// Check if url-node already in index
			var nodeVal *Node
			iVal, found := bw.URLIndex.Get(currentNode.URL)

			nameHash := xxhash.ChecksumString64(currentNode.Name)
			// If node url not in index, add it to index
			if !found {
				//log.Debugf("Not found")

				// store hash(name)
				currentNode.NameHash = nameHash

				// The value in the index will be a
				// pointer to currentNode
				//log.Debugf("Inserting url %s to index", nodeURL)
				bw.URLIndex.Insert(currentNode.URL, currentNode)

				// Run tag parsing hooks
				bw.RunParseHooks(currentNode)

				// If we find the node already in index
				// we check if the hash(name) changed  meaning
				// the data changed
			} else {
				//log.Debugf("URL Found in index")
				nodeVal = iVal.(*Node)

				// hash(name) is different meaning new commands/tags could
				// be added, we need to process the parsing hoos
				if nodeVal.NameHash != nameHash {
					//log.Debugf("URL name changed !")

					// Run parse hooks on node
					bw.RunParseHooks(currentNode)
				}

				// Else we do nothing, the node will not
				// change
			}

			//If parent is folder, add it as tag and add current node as child
			//And add this link as child
			if currentNode.Parent.Type == jsonNodeTypes.Folder {
				//log.Debug("Parent is folder, parsing as tag ...")
				currentNode.Tags = append(currentNode.Tags, currentNode.Parent.Name)
			}

		}

		return nil
	}

	rootsData, _, _, _ := jsonparser.Get(f, "roots")

	// Start a new node tree building job
	start := time.Now()
	jsonparser.ObjectEach(rootsData, jsonParseRoots)
	bw.Stats.lastParseTime = time.Since(start)
	log.Debugf("<%s> parsed tree in %s", bw.name, bw.Stats.lastParseTime)
	// Finished node tree building job

	// Debug walk tree
	//go PrintTree(bw.NodeTree)

	// Reset the index to represent the nodetree
	bw.RebuildIndex()

	// Finished parsing
	log.Debugf("<%s> parsed %d bookmarks and %d nodes", bw.name, bw.Stats.currentUrlCount, bw.Stats.currentNodeCount)

	// Reset parser counter
	bw.ResetStats()

	//Add nodeTree to Cache
	//log.Debugf("<%s> buffer content", bw.name)
	//bw.BufferDB.Print()

	log.Debugf("<%s> syncing to buffer", bw.name)
	syncTreeToBuffer(bw.NodeTree, bw.BufferDB)
	log.Debugf("<%s> tree synced to buffer", bw.name)

	//bw.BufferDB.Print()

	// cacheDB represents bookmarks across all browsers
	// From browsers it should support: add/update
	// Delete method should only be possible through admin interface
	// We could have an @ignore command to ignore a bookmark

	// URLIndex is a hashmap index of all URLS representing current state
	// of the browser

	// nodeTree is current state of the browser as tree

	// Buffer is the current state of the browser represetned by
	// URLIndex and nodeTree

	// If cacheDB is empty just copy buffer to cacheDB
	// until local db is already populated and preloaded
	//debugPrint("%d", BufferDB.Count())
	if empty, err := CacheDB.isEmpty(); empty {
		if err != nil {
			log.Error(err)
		}
		log.Info("cache empty: loading buffer to Cachedb")

		//start := time.Now()
		bw.BufferDB.CopyTo(CacheDB)
		//debugPrint("<%s> is now (%d)", CacheDB.name, cacheDB.Count())
		//elapsed := time.Since(start)
		//debugPrint("copy in %s", elapsed)

		log.Debugf("syncing <%s> to disk", CacheDB.name)
		CacheDB.SyncToDisk(getDBFullPath())
	}

	bw.BufferDB.SyncTo(CacheDB)

}