Changeset 5665

Timestamp:

02/23/10 11:19:17 (3 years ago)

Author:

blogic

Message:

luci2 - improve api for widget handling. widget properties can now be forced.

Location:

luci2/cbi2

Files:

• cbi.c (modified) (14 diffs)
• cbi.h (modified) (4 diffs)
• Makefile (modified) (1 diff)
• network.luci (modified) (3 diffs)
• widget.c (modified) (1 diff)
• widget.h (added)
• widgets/element.c (deleted)
• widgets/field.c (added)
• widgets/foreach.c (added)
• widgets/form.c (modified) (1 diff)
• widgets/option.c (modified) (1 diff)
• widgets/page.c (modified) (1 diff)
• widgets/section.c (modified) (1 diff)

luci2/cbi2/cbi.c

@@ -86 +86 @@
 }
 
-const char* cbi_find_prop(struct cbi_element *e, char *key)
+const char* cbi_find_prop(struct cbi_element *e, const char *key)
 {
     struct list_head *q;
@@ -107 +107 @@
 }
 
-void cbi_get_element_name(struct cbi_element *e, char *buffer, int file)
-{
-    const char *name;
+void cbi_get_element_id(struct cbi_element *e, char *buffer, int file)
+{
+    const char *id;
     if(!e)
         return;
-    cbi_get_element_name(e->parent, buffer, file);
-    name = cbi_find_prop(e, "name");
+    cbi_get_element_id(e->parent, buffer, file);
+    id = cbi_find_prop(e, "id");
+    if(!id && (e->caps & UCI))
+        id = cbi_find_prop(e, "uci");
+    if(!id)
+        return;
     if(file && e->file && !e->parent)
     {
@@ -120 +124 @@
     } else if(*buffer)
         strcat(buffer, ".");
-    strcat(buffer, name);
-}
-
-void cbi_gen_default_name(struct cbi_element *e, int *count)
+    strcat(buffer, id);
+}
+
+void cbi_gen_default_id(struct cbi_element *e, int *count)
 {
     char tmp[128];
     char buffer[256];
-    const char *name = cbi_find_prop(e, "name");
-    if(name)
+    const char *id = cbi_find_prop(e, "id");
+    if(id)
         return;
-    name = cbi_find_prop(e, "uci");
-    if(name)
-    {
-        cbi_add_property(e, "name", name, 1);
+    if(e->caps & UCI)
+        id = cbi_find_prop(e, "uci");
+    if(!id)
+        id = cbi_find_prop(e, "name");
+    if(id)
+    {
+        cbi_add_property(e, "id", id, 1);
         return;
     }
@@ -141 +148 @@
         snprintf(tmp, 127, "%s%d", e->widget, *count);
     tmp[127] = '\0';
-    cbi_add_property(e, "name", tmp, 1);
+    cbi_add_property(e, "id", tmp, 1);
     *buffer = 0;
     if(e->parent)
     {
-        cbi_get_element_name(e->parent, buffer, 1);
-        printf("generating name for %s.%s\n", buffer, tmp);
+        cbi_get_element_id(e->parent, buffer, 1);
+        //printf("generating id for %s\n", buffer);
+        printf("generating id for %s\n", tmp);
     } else if(e->file)
-        printf("generating name for %s:%s\n", e->file->name, tmp);
+        printf("generating id for %s:%s\n", e->file->name, tmp);
     (*count)++;
 }
@@ -231 +239 @@
         }
     }
-/*  if((e->caps & PACKAGE) || (e->caps & SECTION && file))
-        cbi_uci_mapping(ctx, e);*/
     return e;
 }
@@ -247 +253 @@
     }
     return 0;
+}
+
+void cbi_index_verify(struct cbi_element *e)
+{
+    struct list_head *p;
+    struct cbi_widget *w = cbi_widget_find(e->widget);
+    if(w)
+        widget_verify(e, w);
+    if(e->broken)
+        return;
+    list_for_each(p, &e->elements)
+    {
+        struct cbi_element *e = container_of(p, struct cbi_element, list);
+        cbi_index_verify(e);
+    }
 }
 
@@ -262 +283 @@
             list_add_tail(&e->index, &ctx->globals);
         }
+        cbi_index_verify(e);
+    }
+}
+
+void cbi_index(struct cbi_ctx *ctx)
+{
+    struct list_head *p;
+    list_for_each(p, &ctx->files)
+    {
+        struct cbi_file *f = container_of(p, struct cbi_file, list);
+        cbi_index_add(ctx, f);
     }
 }
@@ -339 +371 @@
 }
 
-int cbi_add_file(struct cbi_ctx *ctx, char *filename)
+int cbi_add_file(struct cbi_ctx *ctx, char *filename, int index)
 {
     struct stat st;
@@ -393 +425 @@
     }
     list_add_tail(&f->list, &ctx->files);
-    cbi_index_add(ctx, f);
+    if(index)
+        cbi_index_add(ctx, f);
     return 0;
 
@@ -410 +443 @@
     struct list_head *p;
     char nl = (!list_empty(&e->elements)?('\n'):('\0'));
+    if(e->broken)
+        return;
     print_spaces(depth);
     printf("<%s:%s", e->namespace, e->widget);
@@ -440 +475 @@
     {
         struct cbi_element *e = container_of(p, struct cbi_element, index);
-        const char *name = cbi_find_prop(e, "name");
-        if(name)
-            printf("%s -> %s\n", e->widget, name);
+        const char *id = cbi_find_prop(e, "id");
+        if(id)
+            printf("%s -> %s\n", e->widget, id);
     }
 }
@@ -474 +509 @@
         int i;
         for(i = 0; i < gl.gl_pathc; i++)
-            cbi_add_file(ctx, gl.gl_pathv[i]);
+            cbi_add_file(ctx, gl.gl_pathv[i], 0);
         globfree(&gl);
     }
@@ -501 +536 @@
         int i;
         for(i = 0; i < gl.gl_pathc; i++)
-            cbi_add_file(ctx, gl.gl_pathv[i]);
+            cbi_add_file(ctx, gl.gl_pathv[i], 1);
         globfree(&gl);
     }
@@ -543 +578 @@
 {
     struct cbi_ctx *ctx = cbi_load_files("/lib/luci2/*.luco");
+    cbi_index(ctx);
     return ctx;
 }

luci2/cbi2/cbi.h

@@ -6 +6 @@
 #include "uvl.h"
 #include "validate.h"
+
+#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 
 #define CBI_LUCI        0x4C554349
@@ -56 +58 @@
     char *value;
     char *packge, *type, *option;
+    int broken;
     _validator validate;
 };
@@ -69 +72 @@
 };
 
+#define PROP_OPTIONAL       0
+#define PROP_REQUIRED       1
+
+struct cbi_widget_property
+{
+    const char *name;
+    int type;
+};
+
 struct cbi_widget
 {
     struct list_head list;
     char *name;
+    int caps;
+    int parent_caps;
+    struct cbi_widget_property *props;
+    int prop_count;
     int (*init)(struct cbi_ctx *ctx, struct cbi_element *e, int *count);
 };
@@ -80 +96 @@
 void cbi_free_context(struct cbi_ctx *ctx);
 void cbi_reindex(struct cbi_ctx *ctx);
-void cbi_gen_default_name(struct cbi_element *e, int *count);
-const char* cbi_find_prop(struct cbi_element *e, char *key);
+void cbi_gen_default_id(struct cbi_element *e, int *count);
+const char* cbi_find_prop(struct cbi_element *e, const char *key);
 void cbi_add_property(struct cbi_element *e, const char *name, const char *val, int generated);
+void cbi_get_element_id(struct cbi_element *e, char *buffer, int file);
+
 
 void cbi_widget_register(char *name, struct cbi_widget *w);
-
 #define WIDGET(widget) \
 void  __attribute__ ((constructor)) \
     widget_##widget##_register(void) \
     { \
-        struct cbi_widget *w = malloc(sizeof(struct cbi_widget)); \
-        memset(w, 0, sizeof(struct cbi_widget)); \
-        w->name = strdup(#widget); \
-        w->init = widget##_init; \
-        cbi_widget_register(#widget, w); \
+        if(widget.props) widget.prop_count = ARRAY_SIZE(widget##_props);\
+        if(!widget.name) widget.name = strdup(#widget); \
+        cbi_widget_register(#widget, & widget); \
     }
+
+#include "widget.h"
+
 #endif

luci2/cbi2/Makefile

@@ -11 +11 @@
     $(CC) $(CFLAGS) -o $@ $^
 
-luci: luci.o cbi.o validate.c uvl.o blob.o validator/boolean.o widgets/page.o widgets/form.o widgets/element.o widgets/section.o widgets/option.o 
+luci: luci.o cbi.o validate.c uvl.o blob.o widget.o validator/boolean.o widgets/page.o widgets/form.o widgets/section.o widgets/option.o widgets/field.o widgets/foreach.o 
     $(CC) $(CFLAGS) -o $@ $^
 

luci2/cbi2/network.luci

@@ -1 @@
-<luci:page name="internet" uci="network">
+
+<luci:page id="internet" uci="network">
     <luci:title>Page title</luci:title>
     Page text
-    <luci:section uci="wan" named="1">
+    <luci:section name="wan" uci="interface">
         <luci:title>Form title</luci:title>
         Form text
@@ -15 +16 @@
         <luci:option uci="password">Password</luci:option>
         <luci:option uci="mtu">MTU</luci:option>
-        <luci:option name="custom">custom</luci:option>
+        <luci:field name="custom">custom</luci:field>
     </luci:section>
 </luci:page>
 
-<luci:section uci="interface">
+<luci:section package="network" uci="interface">
     <luci:title>Lan Configuration</luci:title>
     Lan Configuration description
@@ -26 +27 @@
 </luci:section>
 
-<luci:page>
-    <luci:section src="network.interface" name="wan" named="1"></luci:section>
-    <luci:section uci="dhcp.dhcp" named="1">
+<luci:page uci="network">
+    <luci:section src="network.interface" name="wan"></luci:section>
+    <luci:section package="dhcp" name="dhcp">
         <luci:option uci="enable">Enable</luci:option>
         <luci:option uci="start">start_ip</luci:option>
         <luci:option uci="stop">stop_ip</luci:option>
-        <luci:foreach uci="dhcp.leases" state="1">
-            <luci:element uci="ip">IP</luci:element>
-            <luci:element uci="mac">MAC</luci:element>
+        <luci:foreach uci="leases">
+            <luci:element name="ip">IP</luci:element>
+            <luci:element name="mac">MAC</luci:element>
         </luci:foreach>
     </luci:section>
 </luci:page>
+<luci:option uci="enable">Enable</luci:option>
+

luci2/cbi2/widget.c

@@ +1 @@
+#include <stdio.h>
+#include "cbi.h"
+
+static int widget_find_prop(const char *name, struct cbi_widget *w)
+{
+    int i;
+    for(i = 0; i < w->prop_count; i++)
+        if(!strcmp(w->props[i].name, name))
+            return 0;
+    return 1;
+}
+
+int widget_verify_props(struct cbi_element *e, struct cbi_widget *w)
+{
+    struct list_head *q;
+    int i;
+    char buf[256];
+    *buf = 0;
+    for(i = 0; i < w->prop_count; i++)
+    {
+        if(w->props[i].type == PROP_REQUIRED)
+            if(!cbi_find_prop(e, w->props[i].name))
+            {
+                cbi_get_element_id(e, buf, 1);
+                printf("%s - missing required property %s\n", buf, w->props[i].name);
+                e->broken = 1;
+                return 1;
+            }
+    }
+    list_for_each(q, &e->properties)
+    {
+        struct cbi_property *p = container_of(q, struct cbi_property, list);
+        if(widget_find_prop(p->key, w))
+        {
+            cbi_get_element_id(e, buf, 1);
+            printf("%s - unknown property %s\n", buf, p->key);
+            e->broken = 1;
+            return 1;
+        }
+    }   return 0;
+}
+
+int widget_verify_parent_caps(struct cbi_element *e, struct cbi_widget *w)
+{
+    char buf[256];
+    *buf = 0;
+    if(!w->parent_caps || e->file)
+        return 0;
+    if(!e->parent)
+        goto error;
+    if((e->parent->caps & w->parent_caps))
+        return 0;
+error:
+    e->broken = 1;
+    cbi_get_element_id(e, buf, 1);
+    printf("%s - parent capabilities were not meet\n", buf);
+    return 1;
+}
+
+int widget_verify_uci(struct cbi_element *e, struct cbi_widget *w)
+{
+    if(!(w->caps | UCI))
+        return 0;
+    if(w->caps & PACKAGE)
+    {
+    }
+    if(w->caps & SECTION)
+    {
+    }
+    if(w->caps & OPTION)
+    {
+    }
+    return 1;
+}
+
+int widget_verify(struct cbi_element *e, struct cbi_widget *w)
+{
+    e->caps = w->caps;
+    if(widget_verify_parent_caps(e, w))
+        return 1;
+    if(widget_verify_props(e, w))
+        return 1;
+    if(widget_verify_uci(e, w))
+        return 1;
+    return 0;
+}

luci2/cbi2/widgets/form.c

@@ -4 +4 @@
 {
     e->caps = SECTION;
-    cbi_gen_default_name(e, count);
+    cbi_gen_default_id(e, count);
     return 0;
 }
 
+struct cbi_widget_property form_props[] = {
+    { "uci", PROP_REQUIRED },
+    { "id", PROP_OPTIONAL },
+};
+
+struct cbi_widget form = {
+    .caps = PAGE | PACKAGE,
+    .props = form_props,
+    .init = form_init,
+};
+
 WIDGET(form)

luci2/cbi2/widgets/option.c

@@ -1 +1 @@
 #include "../cbi.h"
+
+struct cbi_widget_property option_props[] = {
+    { "uci", PROP_REQUIRED },
+    { "section", PROP_OPTIONAL },
+    { "package", PROP_OPTIONAL },
+    { "id", PROP_OPTIONAL },
+};
 
 int option_init(struct cbi_ctx *ctx, struct cbi_element *e, int *count)
 {
     e->caps = UCI | OPTION;
-    cbi_gen_default_name(e, count);
+    cbi_gen_default_id(e, count);
+/*  if(widget_verify_parent_caps(e, SECTION))
+        return 1;
+    if(widget_verify_props(e, option_props, ARRAY_SIZE(option_props)))
+        return 1;*/
     return 0;
 }
 
+struct cbi_widget option = {
+    .caps = UCI | OPTION,
+    .parent_caps = SECTION,
+    .props = option_props,
+    .init = option_init,
+};
+
 WIDGET(option)

luci2/cbi2/widgets/page.c

@@ -3 +3 @@
 int page_init(struct cbi_ctx *ctx, struct cbi_element *e, int *count)
 {
-    const char *uci;
-    e->caps = PACKAGE | PAGE;
-    cbi_gen_default_name(e, count);
-    uci = cbi_find_prop(e, "uci");
-    if(!uci && e->file)
-        cbi_add_property(e, "uci", e->file->name, 1);
-    else if(!uci)
-        cbi_add_property(e, "uci", cbi_find_prop(e, "name"), 1);
+    cbi_gen_default_id(e, count);
     return 0;
 }
 
+struct cbi_widget_property page_props[] = {
+    { "uci", PROP_REQUIRED },
+    { "id", PROP_OPTIONAL },
+};
+
+struct cbi_widget page = {
+    .caps = UCI | PAGE | PACKAGE,
+    .props = page_props,
+    .init = page_init,
+};
+
 WIDGET(page)

luci2/cbi2/widgets/section.c

@@ -4 +4 @@
 {
     e->caps = UCI | SECTION;
-    cbi_gen_default_name(e, count);
+    cbi_gen_default_id(e, count);
     return 0;
 }
 
+struct cbi_widget_property section_props[] = {
+    { "uci", PROP_REQUIRED },
+    { "name", PROP_OPTIONAL },
+    { "package", PROP_OPTIONAL },
+    { "id", PROP_OPTIONAL },
+};
+
+struct cbi_widget section = {
+    .caps = UCI | SECTION,
+    .parent_caps = PACKAGE,
+    .props = section_props,
+    .init = section_init,
+};
+
 WIDGET(section)