docset-sfdc/SFDashC/structs.go

package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"strings"
)

// JSON Structs

// AtlasTOC represents the meta documenation from Salesforce
type AtlasTOC struct {
	AvailableVersions []VersionInfo `json:"available_versions"`
	Content           string
	ContentDocumentID string `json:"content_document_id"`
	Deliverable       string
	DocTitle          string `json:"doc_title"`
	Locale            string
	Language          LanguageInfo
	PDFUrl            string     `json:"pdf_url"`
	TOCEntries        []TOCEntry `json:"toc"`
	Title             string
	Version           VersionInfo
}

// LanguageInfo contains information for linking and displaying the language
type LanguageInfo struct {
	Label  string
	Locale string
	URL    string
}

// VersionInfo representes a Salesforce documentation version
type VersionInfo struct {
	DocVersion     string `json:"doc_version"`
	ReleaseVersion string `json:"release_version"`
	VersionText    string `json:"version_text"`
	VersionURL     string `json:"version_url"`
}

// TOCEntry represents a single Table of Contents item
type TOCEntry struct {
	Text                    string
	ID                      string
	LinkAttr                LinkAttr `json:"a_attr,omitempty"`
	Children                []TOCEntry
	ComputedFirstTopic      bool
	ComputedResetPageLayout bool
}

// LinkAttr represents all attributes bound to a link
type LinkAttr struct {
	Href string
}

// TOCContent contains content information for a piece of documenation
type TOCContent struct {
	ID      string
	Title   string
	Content string
}

// SupportedType contains information for generating indexes for types we care about
type SupportedType struct {
	// Exact match against an id
	ID string
	// Match against a prefix for the id
	IDPrefix string
	// Match against a prefix for the title
	TitlePrefix string
	// Match against a suffix for the title
	TitleSuffix string
	// Override Title
	TitleOverride string
	// Docset type
	TypeName string
	// Not sure...
	AppendParents bool
	// Skip trimming of suffix from title
	NoTrim bool
	// Not sure...
	ParseContent bool
	// Should this name be pushed int othe path for child entries Eg. Class name prefix methods
	PushName bool
	// Should a namspace be prefixed to the database entry
	ShowNamespace bool
	// Indicates that this just contains other nodes and we don't want to index this node
	// This type will cascade down one level, but IsContainer itself is not hereditary
	IsContainer bool
	// Indicates that this and all nodes underneith should be hidden
	IsHidden bool
	// Should cascade type downwards unless the child has it's own type
	CascadeType bool
	// Should cascade type downwards, even if children have their own type
	ForceCascadeType bool
}

// Sqlite Struct
// SearchIndex is the database table that indexes the docs
type SearchIndex struct {
	ID   int64  `db:id`
	Name string `db:name`
	Type string `db:type`
	Path string `db:path`
}

// matchesTitle returns true if the title matches that of the specified type
func (suppType SupportedType) matchesTitle(title string) bool {
	match := false
	match = match || (suppType.TitlePrefix != "" &&
		strings.HasPrefix(title, suppType.TitlePrefix))
	match = match || (suppType.TitleSuffix != "" &&
		strings.HasSuffix(title, suppType.TitleSuffix))
	return match
}

// matchesID returns true if the ID matches that of the specified type
func (suppType SupportedType) matchesID(id string) bool {
	if suppType.ID != "" && suppType.ID == id {
		return true
	}
	if suppType.IDPrefix != "" {
		return strings.HasPrefix(id, suppType.IDPrefix)
	}
	return false
}

// ShouldCascade returns if this type should be cascaded down to the child
func (suppType SupportedType) ShouldCascade() bool {
	return suppType.ForceCascadeType || suppType.CascadeType || suppType.IsContainer
}

// CreateChildType returns a child type inheriting the current type
func (suppType SupportedType) CreateChildType() SupportedType {
	// Reset values that do not cascade
	suppType.IsContainer = false
	return suppType
}

func (suppType SupportedType) ShouldSkipIndex() bool {
	return suppType.IsContainer || suppType.IsHidden
}

// IsValidType returns whether or not this is a valid type
func (suppType SupportedType) IsValidType() bool {
	return suppType.TypeName != ""
}

// IsType indicates that the TOCEntry is of a given SupportedType
// This is done by checking the suffix of the entry text
func (entry TOCEntry) IsType(t SupportedType) bool {
	return t.matchesTitle(entry.Text) || t.matchesID(entry.ID)
}

// CleanTitle trims known suffix from TOCEntry titles
func (entry TOCEntry) CleanTitle(t SupportedType) string {
	if t.TitleOverride != "" {
		return t.TitleOverride
	}
	if t.NoTrim {
		return entry.Text
	}
	return strings.TrimSuffix(entry.Text, " "+t.TitleSuffix)
}

// GetRelLink extracts only the relative link from the Link Href
func (entry TOCEntry) GetRelLink(removeAnchor bool) (relLink string) {
	if entry.LinkAttr.Href == "" {
		return
	}

	// Get the JSON file
	relLink = entry.LinkAttr.Href
	if removeAnchor {
		anchorIndex := strings.LastIndex(relLink, "#")
		if anchorIndex > 0 {
			relLink = relLink[0:anchorIndex]
		}
	}
	return
}

// GetContent retrieves Content for this TOCEntry from the API
func (entry TOCEntry) GetContent(toc *AtlasTOC) (content *TOCContent, err error) {
	relLink := entry.GetRelLink(true)
	if relLink == "" {
		return
	}

	url := fmt.Sprintf(
		"https://developer.salesforce.com/docs/get_document_content/%s/%s/%s/%s",
		toc.Deliverable,
		relLink,
		toc.Locale,
		toc.Version.DocVersion,
	)

	resp, err := http.Get(url)
	if err != nil {
		return
	}

	// Read the downloaded JSON
	defer func() {
		ExitIfError(resp.Body.Close())
	}()
	contents, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return
	}

	// Load into Struct
	content = new(TOCContent)
	err = json.Unmarshal([]byte(contents), content)
	if err != nil {
		fmt.Println("Error reading JSON")
		fmt.Println(resp.Status)
		fmt.Println(url)
		fmt.Println(string(contents))
		return
	}
	return
}

// GetContentFilepath returns the filepath that should be used for the content
func (entry TOCEntry) GetContentFilepath(toc *AtlasTOC, removeAnchor bool) string {
	relLink := entry.GetRelLink(removeAnchor)
	if relLink == "" {
		ExitIfError(NewFormatedError("Link not found for %s", entry.ID))
	}

	return fmt.Sprintf("atlas.%s.%s.meta/%s/%s", toc.Locale, toc.Deliverable, toc.Deliverable, relLink)
}