src/scripting/smjs/globhist.c

   1 /* "elinks.globhist" */
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 #include "elinks.h"
   8
   9 #include "globhist/globhist.h"
  10 #include "ecmascript/spidermonkey-shared.h"
  11 #include "scripting/smjs/core.h"
  12 #include "scripting/smjs/elinks_object.h"
  13 #include "util/memory.h"
  14
  15
  16 static const JSClass smjs_globhist_item_class; /* defined below */
  17
  18
  19 /* @smjs_globhist_item_class.finalize */
  20 static void
  21 smjs_globhist_item_finalize(JSContext *ctx, JSObject *obj)
  22 {
  23         struct global_history_item *history_item;
  24
  25         assert(JS_InstanceOf(ctx, obj, (JSClass *) &smjs_globhist_item_class, NULL));
  26         if_assert_failed return;
  27
  28         history_item = JS_GetInstancePrivate(ctx, obj,
  29                                              (JSClass *) &smjs_globhist_item_class,
  30                                              NULL);
  31
  32         if (history_item) object_unlock(history_item);
  33 }
  34
  35 /* Tinyids of properties.  Use negative values to distinguish these
  36  * from array indexes (even though this object has no array elements).
  37  * ECMAScript code should not use these directly as in global_history_item[-1];
  38  * future future versions of ELinks may change the numbers.  */
  39 enum smjs_globhist_item_prop {
  40         GLOBHIST_TITLE      = -1,
  41         GLOBHIST_URL        = -2,
  42         GLOBHIST_LAST_VISIT = -3,
  43 };
  44
  45 static const JSPropertySpec smjs_globhist_item_props[] = {
  46         { "title",      GLOBHIST_TITLE,      JSPROP_ENUMERATE },
  47         { "url",        GLOBHIST_URL,        JSPROP_ENUMERATE },
  48         { "last_visit", GLOBHIST_LAST_VISIT, JSPROP_ENUMERATE },
  49         { NULL }
  50 };
  51
  52 /* @smjs_globhist_item_class.getProperty */
  53 static JSBool
  54 smjs_globhist_item_get_property(JSContext *ctx, JSObject *obj, jsid id,
  55                                 jsval *vp)
  56 {
  57         struct global_history_item *history_item;
  58
  59         /* This can be called if @obj if not itself an instance of the
  60          * appropriate class but has one in its prototype chain.  Fail
  61          * such calls.  */
  62         if (!JS_InstanceOf(ctx, obj, (JSClass *) &smjs_globhist_item_class, NULL))
  63                 return JS_FALSE;
  64
  65         history_item = JS_GetInstancePrivate(ctx, obj,
  66                                              (JSClass *) &smjs_globhist_item_class,
  67                                              NULL);
  68
  69         if (!history_item) return JS_FALSE;
  70
  71         undef_to_jsval(ctx, vp);
  72
  73         if (!JSID_IS_INT(id))
  74                 return JS_FALSE;
  75
  76         switch (JSID_TO_INT(id)) {
  77         case GLOBHIST_TITLE:
  78                 *vp = STRING_TO_JSVAL(JS_NewStringCopyZ(smjs_ctx,
  79                                                         history_item->title));
  80
  81                 return JS_TRUE;
  82         case GLOBHIST_URL:
  83                 *vp = STRING_TO_JSVAL(JS_NewStringCopyZ(smjs_ctx,
  84                                                         history_item->url));
  85
  86                 return JS_TRUE;
  87         case GLOBHIST_LAST_VISIT:
  88                 /* TODO: I'd rather return a date object, but that introduces
  89                  * synchronisation issues:
  90                  *
  91                  *  - How do we cause a change to that date object to affect
  92                  *    the actual global history item?
  93                  *  - How do we get a change to that global history item
  94                  *    to affect all date objects?
  95                  *
  96                  * The biggest obstacle is that we have no way to trigger code
  97                  * when one messes with the date object.
  98                  *
  99                  *   -- Miciah */
 100                 /* XXX: Currently, ECMAScript gets seconds since the epoch.
 101                  * Since the Date object uses milliseconds since the epoch,
 102                  * I'd rather export that, but SpiderMonkey doesn't provide
 103                  * a suitable type. -- Miciah */
 104                 JS_NewNumberValue(smjs_ctx, history_item->last_visit, vp);
 105
 106                 return JS_TRUE;
 107         default:
 108                 /* Unrecognized integer property ID; someone is using
 109                  * the object as an array.  SMJS builtin classes (e.g.
 110                  * js_RegExpClass) just return JS_TRUE in this case
 111                  * and leave *@vp unchanged.  Do the same here.
 112                  * (Actually not quite the same, as we already used
 113                  * @undef_to_jsval.)  */
 114                 return JS_TRUE;
 115         }
 116 }
 117
 118 /* @smjs_globhist_item_class.setProperty */
 119 static JSBool
 120 smjs_globhist_item_set_property(JSContext *ctx, JSObject *obj, jsid id, JSBool strict, jsval *vp)
 121 {
 122         struct global_history_item *history_item;
 123
 124         /* This can be called if @obj if not itself an instance of the
 125          * appropriate class but has one in its prototype chain.  Fail
 126          * such calls.  */
 127         if (!JS_InstanceOf(ctx, obj, (JSClass *) &smjs_globhist_item_class, NULL))
 128                 return JS_FALSE;
 129
 130         history_item = JS_GetInstancePrivate(ctx, obj,
 131                                              (JSClass *) &smjs_globhist_item_class,
 132                                              NULL);
 133
 134         if (!history_item) return JS_FALSE;
 135
 136         if (!JSID_IS_INT(id))
 137                 return JS_FALSE;
 138
 139         switch (JSID_TO_INT(id)) {
 140         case GLOBHIST_TITLE: {
 141                 JSString *jsstr = JS_ValueToString(smjs_ctx, *vp);
 142                 unsigned char *str = JS_EncodeString(smjs_ctx, jsstr);
 143
 144                 mem_free_set(&history_item->title, stracpy(str));
 145
 146                 return JS_TRUE;
 147         }
 148         case GLOBHIST_URL: {
 149                 JSString *jsstr = JS_ValueToString(smjs_ctx, *vp);
 150                 unsigned char *str = JS_EncodeString(smjs_ctx, jsstr);
 151
 152                 mem_free_set(&history_item->url, stracpy(str));
 153
 154                 return JS_TRUE;
 155         }
 156         case GLOBHIST_LAST_VISIT: {
 157                 uint32 seconds;
 158
 159                 /* Bug 923: Assumes time_t values fit in uint32.  */
 160                 JS_ValueToECMAUint32(smjs_ctx, *vp, &seconds);
 161                 history_item->last_visit = seconds;
 162
 163                 return JS_TRUE;
 164         }
 165         default:
 166                 /* Unrecognized integer property ID; someone is using
 167                  * the object as an array.  SMJS builtin classes (e.g.
 168                  * js_RegExpClass) just return JS_TRUE in this case.
 169                  * Do the same here.  */
 170                 return JS_TRUE;
 171         }
 172 }
 173
 174 static const JSClass smjs_globhist_item_class = {
 175         "global_history_item",
 176         JSCLASS_HAS_PRIVATE,    /* struct global_history_item * */
 177         JS_PropertyStub, JS_PropertyStub,
 178         smjs_globhist_item_get_property, smjs_globhist_item_set_property,
 179         JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub,
 180         smjs_globhist_item_finalize,
 181 };
 182
 183 static JSObject *
 184 smjs_get_globhist_item_object(struct global_history_item *history_item)
 185 {
 186         JSObject *jsobj;
 187
 188         jsobj = JS_NewObject(smjs_ctx, (JSClass *) &smjs_globhist_item_class,
 189                              NULL, NULL);
 190         if (!jsobj
 191             || JS_TRUE != JS_DefineProperties(smjs_ctx, jsobj,
 192                                    (JSPropertySpec *) smjs_globhist_item_props)
 193             || JS_TRUE != JS_SetPrivate(smjs_ctx, jsobj, history_item)) /* to @smjs_globhist_item_class */
 194                 return NULL;
 195
 196         object_lock(history_item);
 197
 198         return jsobj;
 199 }
 200
 201
 202 /* @smjs_globhist_class.getProperty */
 203 static JSBool
 204 smjs_globhist_get_property(JSContext *ctx, JSObject *obj, jsid id, jsval *vp)
 205 {
 206         JSObject *jsobj;
 207         unsigned char *uri_string;
 208         struct global_history_item *history_item;
 209         jsval tmp;
 210
 211         if (!JS_IdToValue(ctx, id, &tmp))
 212                 goto ret_null;
 213
 214         uri_string = JS_EncodeString(ctx, JS_ValueToString(ctx, tmp));
 215         if (!uri_string) goto ret_null;
 216
 217         history_item = get_global_history_item(uri_string);
 218         if (!history_item) goto ret_null;
 219
 220         jsobj = smjs_get_globhist_item_object(history_item);
 221         if (!jsobj) goto ret_null;
 222
 223         *vp = OBJECT_TO_JSVAL(jsobj);
 224
 225         return JS_TRUE;
 226
 227 ret_null:
 228         *vp = JSVAL_NULL;
 229
 230         return JS_TRUE;
 231 }
 232
 233 static const JSClass smjs_globhist_class = {
 234         "global_history", 0,
 235         JS_PropertyStub, JS_PropertyStub,
 236         smjs_globhist_get_property, JS_StrictPropertyStub,
 237         JS_EnumerateStub, JS_ResolveStub, JS_ConvertStub, JS_FinalizeStub,
 238 };
 239
 240 static JSObject *
 241 smjs_get_globhist_object(void)
 242 {
 243         JSObject *globhist;
 244
 245         globhist = JS_NewObject(smjs_ctx, (JSClass *) &smjs_globhist_class,
 246                                 NULL, NULL);
 247         if (!globhist) return NULL;
 248
 249         return globhist;
 250 }
 251
 252 void
 253 smjs_init_globhist_interface(void)
 254 {
 255         jsval val;
 256         struct JSObject *globhist;
 257
 258         if (!smjs_ctx || !smjs_elinks_object)
 259                 return;
 260
 261         globhist = smjs_get_globhist_object();
 262         if (!globhist) return;
 263
 264         val = OBJECT_TO_JSVAL(globhist);
 265
 266         JS_SetProperty(smjs_ctx, smjs_elinks_object, "globhist", &val);
 267 }