s/?export/?compact/

Signed-off-by: Doug Davis <[email protected]>

Author: duglin

cmds/server/loader.go

@@ -291,7 +291,7 @@ func LoadDirsSample(reg *registry.Registry) *registry.Registry {
 
 	ErrFatalf(reg.Model.Verify())
 
-	g, err := reg.AddGroup("dirs", "dir1")
+	g, err := reg.AddGroup("dirs", "d1")
 	ErrFatalf(err)
 	ErrFatalf(g.SetSave("labels.private", "true"))
 	r, err := g.AddResource("files", "f1", "v1")
@@ -303,10 +303,16 @@ func LoadDirsSample(reg *registry.Registry) *registry.Registry {
 	ErrFatalf(r.SetSaveMeta("labels.none", ""))
 	ErrFatalf(r.SetSaveMeta("rext", "a string"))
 	ErrFatalf(r.SetSaveDefault("vext", "a ver string"))
-	ErrFatalf(reg.SetSave("resptr", "/dirs/dir1/files/f1/versions/v1"))
+	ErrFatalf(reg.SetSave("resptr", "/dirs/d1/files/f1/versions/v1"))
 
 	_, err = g.AddResource("datas", "d1", "v1")
 
+	_, err = g.AddResourceWithObject("files", "fx", "",
+		map[string]any{
+			"meta": map[string]any{"xref": "/dirs/d1/files/f1"},
+		}, true, false)
+	ErrFatalf(err)
+
 	reg.Commit()
 	return reg
 }

registry/capabilities.go

@@ -20,7 +20,7 @@ type Capabilities struct {
 }
 
 var AllowableFlags = ArrayToLower([]string{
-	"epoch", "export", "filter", "inline",
+	"epoch", "compact", "filter", "inline",
 	"nested", "nodefaultversionid", "nodefaultversionsticky",
 	"noepoch", "noreadonly", "schema", "setdefaultversionid", "specversion"})
 

registry/entity.go

@@ -601,7 +601,7 @@ func (e *Entity) SetDBProperty(pp *PropPath, val any) error {
 	PanicIf(e.Registry == nil, "Registry should not be nil")
 
 	// #resource is special and is saved in it's own table
-	// Need to explicitly set #resoure to nil to delete it.
+	// Need to explicitly set #resource to nil to delete it.
 	if pp.Len() == 1 && pp.Top() == "#resource" {
 		if IsNil(val) {
 			err = Do(e.tx, `DELETE FROM ResourceContents WHERE VersionSID=?`,
@@ -618,6 +618,12 @@ func (e *Entity) SetDBProperty(pp *PropPath, val any) error {
 			if err != nil {
 				return err
 			}
+
+			// DUG TODO for fixing xref #resource issue
+			// Store versionSID as #resource's value, we'll use that
+			// as the look-up into the ResourceContents table. We can't
+			// count on the VersionSID because when we're in an xref'd
+			// entity the VersionSID won't be correct
 			val = ""
 			// Fall thru to normal processing so we save a placeholder
 			// attribute in the resource
@@ -674,7 +680,7 @@ func (e *Entity) SetDBProperty(pp *PropPath, val any) error {
 
 		err = DoOneTwo(e.tx, `
             REPLACE INTO Props(
-              RegistrySID, EntitySID, PropName, PropValue, PropType, Export)
+              RegistrySID, EntitySID, PropName, PropValue, PropType, Compact)
             VALUES( ?,?,?,?,?, true )`,
 			e.Registry.DbSID, e.DbSID, name, dbVal, propType)
 	}
@@ -1013,7 +1019,7 @@ var OrderedSpecProps = []*Attribute{
 
 				if e.Type == ENTITY_RESOURCE || e.Type == ENTITY_VERSION {
 					meta := info != nil && (info.ShowStructure ||
-						info.HasFlag("export") ||
+						info.HasFlag("compact") ||
 						info.ResourceUID == "" || len(info.Parts) == 5)
 					_, rm := e.GetModels()
 					if rm.GetHasDocument() == false {
@@ -1048,7 +1054,7 @@ var OrderedSpecProps = []*Attribute{
 					}
 					if e.Type == ENTITY_RESOURCE || e.Type == ENTITY_VERSION {
 						meta := info != nil && (info.ShowStructure ||
-						info.HasFlag("export") ||
+						info.HasFlag("compact") ||
 						info.ResourceUID == "" || len(info.Parts) == 5)
 						_, rm := e.GetModels()
 						if rm.GetHasDocument() == false {
@@ -1456,7 +1462,7 @@ var OrderedSpecProps = []*Attribute{
 				tmp := base + "/" + rPath + "/versions/" + val.(string)
 
 				meta := info != nil && (info.ShowStructure ||
-					info.HasFlag("export") || info.ResourceUID == "")
+					info.HasFlag("compact") || info.ResourceUID == "")
 				_, rm := e.GetModels()
 				if rm.GetHasDocument() == false {
 					meta = false

registry/httpStuff.go

@@ -362,11 +362,11 @@ func (pw *PageWriter) Done() {
 
 	if pw.Info.RootPath == "" {
 		checked := ""
-		if pw.Info.HasFlag("export") {
+		if pw.Info.HasFlag("compact") {
 			checked = " checked"
 		}
-		options += "    <div class=export>\n" +
-			"      <input id=export type='checkbox'" + checked + "/>export\n" +
+		options += "    <div class=compact>\n" +
+			"      <input id=compact type='checkbox'" + checked + "/>compact\n" +
 			"    </div>\n"
 
 		if options != "" { // Wrapper if any
@@ -405,16 +405,13 @@ func (pw *PageWriter) Done() {
 	// Process inlines
 
 	// check to see if the currently selected inlines are the default
-	// ones based on any variant of 'export'
+	// ones based on presence of '/export'
 	defaultInlines := false
 	if pw.Info.RootPath == "export" {
 		defaultInlines = (len(pw.Info.Inlines) == 3 &&
 			pw.Info.IsInlineSet(NewPPP("capabilities").DB()) &&
 			pw.Info.IsInlineSet(NewPPP("model").DB()) &&
 			pw.Info.IsInlineSet(NewPPP("*").DB()))
-	} else if pw.Info.RootPath == "" && pw.Info.HasFlag("export") {
-		defaultInlines = (len(pw.Info.Inlines) == 1 &&
-			pw.Info.IsInlineSet(NewPPP("*").DB()))
 	}
 
 	if pw.Info.RootPath == "" || pw.Info.RootPath == "export" {
@@ -695,7 +692,7 @@ func (pw *PageWriter) Done() {
     font-weight: bold ;
     margin-left: 3px ;
   }
-  .export {
+  .compact {
     margin-top: 5px ;
     font-size: 13px ;
     font-family: courier ;
@@ -860,8 +857,8 @@ function apply() {
   if (structureswitch) loc += "$structure"
   loc += "?ui"
 
-  ex = document.getElementById("export")
-  if (ex != null && ex.checked) loc += "&export"
+  ex = document.getElementById("compact")
+  if (ex != null && ex.checked) loc += "&compact"
 
   var filters = document.getElementById("filters").value
   var lines = filters.split("\n")
@@ -1131,7 +1128,12 @@ FROM FullTree WHERE RegSID=? AND `
 			v, err := readNextEntity(info.tx, results)
 
 			if v != nil && v.Type == ENTITY_META {
-				// Skip the "meta" subobject
+				// Skip the "meta" subobject, but first grab the
+				// "defaultversionid if we don't already have it,
+				// which should only be true in the xref case
+				if vID == "" {
+					vID = v.GetAsString("defaultversionid")
+				}
 				continue
 			}
 
@@ -1282,7 +1284,7 @@ func HTTPGet(info *RequestInfo) error {
 	// response body or not (meaning, the hasDoc doc)
 	metaInBody := (info.ResourceModel == nil) ||
 		(info.ResourceModel.GetHasDocument() == false || info.ShowStructure ||
-			info.HasFlag("export") ||
+			info.HasFlag("compact") ||
 			(len(info.Parts) == 5 && info.Parts[4] == "meta"))
 
 	// Return the Resource's document
@@ -1316,14 +1318,11 @@ func SerializeQuery(info *RequestInfo, paths []string, what string,
 		info.AddInline("capabilities")
 		info.AddInline("model")
 	}
-	if info.RootPath == "" && info.HasFlag("export") && len(info.Inlines) == 0 {
-		info.AddInline("*")
-	}
 
-	doExport := info.HasFlag("export") || info.RootPath == "export"
+	doCompact := info.HasFlag("compact") || info.RootPath == "export"
 
 	query, args, err := GenerateQuery(info.Registry, what, paths, filters,
-		doExport)
+		doCompact)
 	results, err := Query(info.tx, query, args...)
 	defer results.Close()
 
@@ -1345,6 +1344,27 @@ func SerializeQuery(info *RequestInfo, paths []string, what string,
 	// Collections will need to print the {}, so don't error for them
 	if what != "Coll" {
 		if jw.Entity == nil {
+			// Special case, if the URL is ../rID/versions/vID?compact then
+			// check to see if Resource has xref set, if so then the error
+			// is 400, not 404
+			if info.VersionUID != "" && info.HasFlag("compact") {
+				path := strings.Join(info.Parts[:len(info.Parts)-2], "/")
+				path += "/meta"
+				entity, err := RawEntityFromPath(info.tx, info.Registry.DbSID,
+					path, false)
+				if err != nil {
+					return err
+				}
+
+				// Assume that if we cant' find the Resource's meta object
+				// then the Resource doesn't exist, so a 404 really is the
+				// best response in those cases, so skip the 400
+				if entity != nil && !IsNil(entity.Object["xref"]) {
+					info.StatusCode = http.StatusBadRequest
+					return fmt.Errorf("'compact' flag not allowed on xref'd Versions")
+				}
+			}
+
 			info.StatusCode = http.StatusNotFound
 			return fmt.Errorf("Not found")
 		}
@@ -1367,14 +1387,15 @@ func SerializeQuery(info *RequestInfo, paths []string, what string,
 		}
 	}
 
-	// Another special case... .../rID/versions?export when rID has xref set
-	if jw.Entity == nil && info.HasFlag("export") && len(info.Parts) == 5 && info.Parts[4] == "versions" {
+	// GROUPS/gID/RESOURCES/rID/versions
+	// Another special case .../rID/versions?compact when rID has xref
+	if jw.Entity == nil && info.HasFlag("compact") && len(info.Parts) == 5 && info.Parts[4] == "versions" {
 		// Should be our case since "versions" can never be empty except
 		// when xref is set. If this is not longer true then we'll need to
 		// check this Resource's xref to see if it's set.
 		// Can copy the RawEntityFromPath... stuff above
-		info.StatusCode = http.StatusNotFound
-		return fmt.Errorf("Not found")
+		info.StatusCode = http.StatusBadRequest
+		return fmt.Errorf("'compact' flag not allowed on xref'd Versions")
 	}
 
 	info.AddHeader("Content-Type", "application/json")

registry/init.sql

@@ -240,13 +240,13 @@ CREATE TABLE Props (
     PropName    VARCHAR(64) NOT NULL,
     PropValue   VARCHAR($MAX_VARCHAR),
     PropType    CHAR(64) NOT NULL,          # string, boolean, int, ...
-    Export      BOOL NOT NULL,              # Should include during export?
+    Compact     BOOL NOT NULL,              # Should include during compact?
 
-    # non-Export-able attributes are ones that are generated at runtime
+    # non-compact-able attributes are ones that are generated at runtime
     # due to things like showing the Default Version props in the Resource
     # or entities/props that materialize due to an xref. Normally a GET
-    # will show all props, but during /export or ?export we want to exclude
-    # these non-Export ones. In case where all of the props for an entity
+    # will show all props, but during /export or ?compact we want to exclude
+    # these non-compact ones. In case where all of the props for an entity
     # are generated, the entire entity should vanish from the serialization.
     # e.g. Versions of an xref'd Resource.
 
@@ -371,7 +371,7 @@ SELECT
     P.PropName,
     P.PropValue,
     P.PropType,
-    false                         # Export
+    false                         # Compact
 FROM xRefSrc2TgtResources AS xR
 JOIN Metas AS Ms ON (Ms.ResourceSID=xR.SourceSID)
 JOIN Metas AS Mt ON (Mt.ResourceSID=xR.TargetSID)
@@ -399,7 +399,7 @@ UNION SELECT                      # Find all Version attributes (not meta)
     P.PropName,
     P.PropValue,
     P.PropType,
-    false                         # Export
+    false                         # Compact
 FROM xRefSrc2TgtResources AS xR
 JOIN Props AS P ON (
     P.EntitySID IN (
@@ -429,7 +429,7 @@ SELECT
     p.PropName,
     p.PropValue,
     p.PropType,
-    false                          # Export
+    false                          # Compact
 FROM EffectiveProps AS p
 JOIN EffectiveVersions AS v ON (p.EntitySID=v.SID)
 JOIN Metas AS m ON (m.ResourceSID=v.ResourceSID)
@@ -457,7 +457,7 @@ UNION SELECT                    # Add Resource.isdefault, always 'true'
     'isdefault$DB_IN',
     'true',
     'boolean',
-    false                       # Export
+    false                       # Compact
 FROM Metas AS m ;
 
 CREATE VIEW AllProps AS
@@ -515,7 +515,7 @@ SELECT
     PropValue,
     PropType,
     Abstract,
-    Export
+    Compact
 FROM Entities
 JOIN AllProps ON (AllProps.EntitySID=Entities.eSID)
 ORDER by Path, PropName;

registry/jsonWriter.go

@@ -275,7 +275,7 @@ func SerializeResourceContents(jw *JsonWriter, e *Entity, info *RequestInfo, ext
 	singular := rm.Singular
 
 	// If the #resource* props aren't there then just exit.
-	// This will happen when "export" is enabled because the
+	// This will happen when "export/compact" is enabled because the
 	// props won't show up in the Resorce but will on the default version
 	// TODO really should do this check in entity.SerializeProps
 	if IsNil(jw.Entity.Object["#resourceURL"]) &&

registry/registry.go

@@ -636,21 +636,21 @@ func (reg *Registry) UpsertGroupWithObject(gType string, id string, obj Object,
 	return g, isNew, nil
 }
 
-func GenerateQuery(reg *Registry, what string, paths []string, filters [][]*FilterExpr, export bool) (string, []interface{}, error) {
+func GenerateQuery(reg *Registry, what string, paths []string, filters [][]*FilterExpr, compact bool) (string, []interface{}, error) {
 	query := ""
 	args := []any{}
 
 	args = []interface{}{reg.DbSID}
 	query = `
 SELECT
   RegSID,Type,Plural,Singular,eSID,UID,PropName,PropValue,PropType,Path,Abstract
-FROM FullTree WHERE RegSID=?` // and Export=true
+FROM FullTree WHERE RegSID=?` // and Compact=true
 
-	// Exclude generated attributes/entityes if export is turned on.
-	// Meaning, only grab Props that have 'Export' set to 'true'. These
+	// Exclude generated attributes/entityes if 'compact' is turned on.
+	// Meaning, only grab Props that have 'Compact' set to 'true'. These
 	// should be (mainly) just the ones we set explicitly.
-	if export {
-		query += ` AND Export=true`
+	if compact {
+		query += ` AND Compact=true`
 	}
 
 	// Remove entities that are higher than the GET PATH specified

registry/resource.go

@@ -2,6 +2,7 @@ package registry
 
 import (
 	"fmt"
+	"reflect"
 	"sort"
 	"strconv"
 	"strings"
@@ -937,6 +938,41 @@ func (m *Meta) Delete() error {
 	return DoOne(m.tx, `DELETE FROM Metas WHERE SID=?`, m.DbSID)
 }
 
+func (m *Meta) xGet(name string) any {
+	log.VPrintf(4, "Meta.Get: r(%s).Get(%s)", m.UID, name)
+
+	if name == m.Singular+"id" {
+		return m.Entity.Get(name)
+	}
+
+	// No matching attr, so check if we need to follow xref, and if there
+	// use that meta
+	if IsNil(m.NewObject[name]) && IsNil(m.Object[name]) {
+		_, xRes, err := m.Resource.GetXref()
+		Must(err)
+		if xRes != nil {
+			m, err = xRes.FindMeta(false)
+			Must(err)
+		}
+	}
+
+	return m.Entity.Get(name)
+}
+
+func (m *Meta) xGetAsString(path string) string {
+	val := m.Get(path)
+	if IsNil(val) {
+		return ""
+	}
+
+	if tmp := reflect.ValueOf(val).Kind(); tmp != reflect.String {
+		panic(fmt.Sprintf("Not a string - got %T(%v)", val, val))
+	}
+
+	str, _ := val.(string)
+	return str
+}
+
 func (r *Resource) GetVersions() ([]*Version, error) {
 	list := []*Version{}