1
  
2
  
3
  
4
  
5
  
6
  
7
  
8
  
9
  
10
  
11
  
12
  
13
  
14
  
15
  
16
  
17
  
18
  
19
  
20
  
21
  
22
  
23
  
24
  
25
  
26
  
27
  
28
  
29
  
30
  
31
  
32
  
33
  
34
  
35
  
36
  
37
  
38
  
39
  
40
  
41
  
42
  
43
  
44
  
45
  
46
  
47
  
48
  
49
  
50
  
51
  
52
  
53
  
54
  
55
  
56
  
57
  
58
  
59
  
60
  
61
  
62
  
63
  
64
  
65
  
66
  
67
  
68
  
69
  
70
  
71
  
72
  
73
  
74
  
75
  
76
  
77
  
78
  
79
  
80
  
81
  
82
  
83
  
84
  
85
  
86
  
87
  
88
  
89
  
90
  
91
  
92
  
93
  
94
  
95
  
96
  
97
  
98
  
99
  
100
  
101
  
102
  
103
  
104
  
105
  
106
  
107
  
108
  
109
  
110
  
111
  
112
  
113
  
114
  
115
  
116
  
117
  
118
  
119
  
120
  
121
  
122
  
123
  
124
  
125
  
126
  
127
  
128
  
129
  
130
  
131
  
132
  
133
  
134
  
135
  
136
  
137
  
138
  
139
  
140
  
141
  
142
  
143
  
144
  
145
  
146
  
147
  
148
  
149
  
150
  
151
  
152
  
153
  
154
  
155
  
156
  
157
  
158
  
159
  
160
  
161
  
162
  
163
  
164
  
165
  
166
  
167
  
168
  
169
  
170
  
171
  
172
  
173
  
174
  
175
  
176
  
177
  
178
  
179
  
180
  
181
  
182
  
183
  
184
  
185
  
186
  
187
  
188
  
189
  
190
  
191
  
192
  
193
  
194
  
195
  
196
  
197
  
198
  
199
  
200
  
201
  
202
  
203
  
204
  
205
  
206
  
207
  
208
  
209
  
210
  
211
  
212
  
213
  
214
  
215
  
216
  
217
  
218
  
219
  
220
  
221
  
222
  
223
  
224
  
225
  
226
  
227
  
228
  
229
  
230
  
231
  
232
  
233
  
234
  
235
  
236
  
237
  
238
  
239
  
240
  
241
  
242
  
243
  
244
  
245
  
246
  
247
  
248
  
249
  
250
  
251
  
252
  
253
  
254
  
255
  
256
  
257
  
258
  
259
  
260
  
261
  
262
  
263
  
264
  
265
  
266
  
267
  
268
  
269
  
270
  
271
  
272
  
273
  
274
  
275
  
276
  
277
  
278
  
279
  
280
  
281
  
282
  
283
  
284
  
285
  
286
  
287
  
288
  
289
  
290
  
291
  
292
  
293
  
294
  
295
  
296
  
297
  
298
  
299
  
300
  
301
  
302
  
303
  
304
  
305
  
306
  
307
  
308
  
309
  
310
  
311
  
312
  
313
  
314
  
315
  
316
  
317
  
318
  
319
  
320
  
321
  
322
  
323
  
324
  
325
  
326
  
327
  
328
  
329
  
330
  
331
  
332
  
333
  
334
  
335
  
336
  
337
  
338
  
339
  
340
  
341
  
342
  
343
  
344
  
345
  
346
  
347
  
348
  
349
  
350
  
351
  
352
  
353
  
354
  
355
  
356
  
357
  
358
  
359
  
360
  
361
  
362
  
363
  
364
  
365
  
366
  
367
  
368
  
369
  
370
  
371
  
372
  
373
  
374
  
375
  
376
  
377
  
378
  
379
  
380
  
381
  
382
  
383
  
384
  
385
  
386
  
387
  
388
  
389
  
390
  
391
  
392
  
393
  
394
  
395
  
396
  
397
  
398
  
399
  
400
  
401
  
402
  
403
  
404
  
405
  
406
  
407
  
408
  
409
  
410
  
411
  
412
  
413
  
414
  
415
  
416
  
417
  
418
  
419
  
420
  
421
  
422
  
423
  
424
  
425
  
#pike __REAL_VERSION__ 
 
//! Various authentication modules and classes. 
//! 
//! @code 
//! constant GOOGLE_KEY = "some-key-911bnn5s.apps.googleusercontent.com"; 
//! constant GOOGLE_SECRET = "5arQDOugDrtIOVklkIet2q2i"; 
//! 
//! Web.Auth.Google.Authorization auth; 
//! 
//! int main(int argc, array(string) argv) 
//! { 
//!   auth = Web.Auth.Google.Authorization(GOOGLE_KEY, GOOGLE_SECRET, 
//!                                        "http://localhost"); 
//! 
//!   // The generated access token will be saved on disk. 
//!   string progname = replace(sprintf("%O", object_program(auth)), ".", "_"); 
//!   string cookie = progname + ".cookie"; 
//! 
//!   // If the cookie exists, set the authentication from the saved values 
//!   if (Stdio.exist(cookie)) { 
//!     auth->set_from_cookie(Stdio.read_file(cookie)); 
//!   } 
//! 
//!   // Not authenticated, can mean no previous authentication is done, or that 
//!   // the authentication has expired. Some services have persistent access tokens 
//!   // some don't 
//!   if (!auth->is_authenticated()) { 
//!     // Try to renew the access token of it's renewable 
//!     if (auth->is_renewable()) { 
//!       write("Trying to refresh token...\n"); 
//!       string data = auth->refresh_access_token(); 
//!       Stdio.write_file(cookie, data); 
//!     } 
//!     else { 
//!       // No argument, start the authentication process 
//!       if (argc == 1) { 
//!         // Get the uri to the authentication page 
//!         string uri = auth->get_auth_uri(); 
//! 
//!         write("Opening \"%s\" in browser.\nCopy the contents of the address " 
//!               "bar into here: ", Standards.URI(uri)); 
//! 
//!         sleep(1); 
//! 
//!         string open_app; 
//! 
//!         // Mac 
//!         if (Process.run(({ "which", "open" }))->exitcode == 0) { 
//!           open_app = "open"; 
//!         } 
//!         // Linux 
//!         else if (Process.run(({ "which", "xdg-open" }))->exitcode == 0) { 
//!           open_app = "xdg-open"; 
//!         } 
//!         // ??? 
//!         else { 
//!           open_app = "open"; 
//!         } 
//! 
//!         Process.create_process(({ open_app, uri })); 
//! 
//!         // Wait for the user to paste the string from the address bar 
//!         string resp = Stdio.Readline()->read(); 
//!         mapping p = Web.Auth.query_to_mapping(Standards.URI(resp)->query); 
//!         string code; 
//! 
//!         // This is if the service is OAuth1 
//!         if (p->oauth_token) { 
//!           auth->set_authentication(p->oauth_token); 
//!           code = p->oauth_verifier; 
//!         } 
//!         // OAuth2 
//!         else { 
//!           code = p->code; 
//!         } 
//!         // Get the access token and save the response to disk for later use. 
//!         string data = auth->request_access_token(code); 
//!         Stdio.write_file(cookie, data); 
//!       } 
//!       // If the user gives the access code from command line. 
//!       else { 
//!         string data = auth->request_access_token(argv[1]); 
//!         Stdio.write_file(cookie, data); 
//!       } 
//!     } 
//!   } 
//! 
//!   if (!auth->is_authenticated()) { 
//!     werror("Authentication failed"); 
//!   } 
//!   else { 
//!     write("Congratulations you are now authenticated\n"); 
//!   } 
//! } 
//! @endcode 
 
// Checks if A is an instance of B (either directly or by inheritance) 
#define INSTANCE_OF(A,B) (object_program((A)) == object_program((B)) || \ 
                          Program.inherits(object_program((A)),         \ 
                          object_program(B))) 
 
//! Parameter collection class 
//! 
//! @seealso 
//!  @[Param] 
class Params 
{ 
  //! The parameters. 
  protected array(Param) params; 
 
  //! Creates a new instance of @[Params] 
  //! 
  //! @param args 
  protected void create(Param ... args) 
  { 
    params = args||({}); 
  } 
 
  //! Sign the parameters 
  //! 
  //! @param secret 
  //!  The API secret 
  string sign(string secret) 
  { 
    // We could stream all the values through MD5, but that is 
    // probably not faster due to call overhead. 
    return String.string2hex(Crypto.MD5.hash(sort(params)->name_value()*"" + secret)); 
  } 
 
  //! Parameter keys 
  protected array(string) _indices() 
  { 
    return params->get_name(); 
  } 
 
  //! Parameter values 
  protected array(string) _values() 
  { 
    return params->get_value(); 
  } 
 
  //! Returns the array of @[Param]eters 
  array(Param) get_params() 
  { 
    return params; 
  } 
 
  string to_unencoded_query() 
  { 
    return params->name_value()*"&"; 
  } 
 
  //! Turns the parameters into a query string 
  string to_query() 
  { 
    array o = ({}); 
    foreach (params, Param p) 
      o += ({ Protocols.HTTP.uri_encode(p->get_name()) + "=" + 
              Protocols.HTTP.uri_encode(p->get_value()) }); 
 
    return o*"&"; 
  } 
 
  //! Turns the parameters into a mapping 
  mapping(string:mixed) to_mapping() 
  { 
    return mkmapping(params->get_name(), params->get_value()); 
  } 
 
  //! Add a mapping of key/value pairs to the current instance 
  //! 
  //! @param value 
  //! 
  //! @returns 
  //!  The object being called 
  this_program add_mapping(mapping value) 
  { 
    foreach (value; string k; mixed v) 
      params += ({ Param(k, (string)v) }); 
 
    return this; 
  } 
 
  //! Add @[p] to the array of @[Param]eters 
  //! 
  //! @param p 
  //! 
  //! @returns 
  //!  A new @[Params] object 
  protected this_program `+(Param|this_program p) 
  { 
    if (mappingp(p)) { 
      foreach (p; string k; string v) { 
        params += ({ Param(k, v) }); 
      } 
 
      return this; 
    } 
 
    if (INSTANCE_OF(p, this)) 
      params += p->get_params(); 
    else 
      params += ({ p }); 
 
    return this; 
  } 
 
  //! Remove @[p] from the @[Param]eters array of the current object. 
  //! 
  //! @param p 
  protected this_program `-(Param|this_program p) 
  { 
    if (!p) return this; 
 
    array(Param) the_params; 
    if (INSTANCE_OF(p, this)) 
      the_params = p->get_params(); 
    else 
      the_params = ({ p }); 
 
    return object_program(this)(@(params-the_params)); 
  } 
 
  //! Index lookup 
  //! 
  //! @param key 
  //! The name of a @[Param]erter to find. 
  protected Param `[](string key) 
  { 
    foreach (params, Param p) 
      if (p->get_name() == key) 
        return p; 
 
    return 0; 
  } 
 
  //! Clone the current instance 
  this_program clone() 
  { 
    return object_program(this)(@params); 
  } 
 
  //! String format method 
  //! 
  //! @param t 
  protected string _sprintf(int t) 
  { 
    return t == 'O' && sprintf("%O(%O)", object_program(this), params); 
  } 
 
  //! Casting method 
  //! 
  //! @param how 
  protected mixed cast(string how) 
  { 
    switch (how) { 
      case "mapping": return to_mapping(); 
      case "string": return to_query(); 
    } 
    error("Cant cast %O() to %O\n", this_program, how); 
  } 
} 
 
//! Representation of a parameter. 
//! 
//! Many Social web services use a RESTful communication and have similiar 
//! API's. This class is suitable for many RESTful web services and if this 
//! class doesn't suite a particular service, just inherit this class and 
//! rewrite the behaviour where needed. 
//! 
//! @seealso 
//!  @[Params] 
class Param 
{ 
  //! The name of the parameter 
  protected string name; 
 
  //! The value of the parameter 
  protected string value; 
 
  //! Creates a new instance of @[Param] 
  //! 
  //! @param name 
  //! @param value 
  protected void create(string name, mixed value) 
  { 
    this::name = name; 
    set_value(value); 
  } 
 
  //! Getter for the parameter name 
  string get_name() 
  { 
    return name; 
  } 
 
  //! Setter for the parameter name 
  //! 
  //! @param name 
  void set_name(string name) 
  { 
    this::name = name; 
  } 
 
  //! Getter for the parameter value 
  string get_value() 
  { 
    return value; 
  } 
 
  //! Setter for the parameter value 
  //! 
  //! @param value 
  void set_value(mixed value) 
  { 
    low_set_value((string)value); 
  } 
 
  //! Returns the name and value as querystring key/value pair 
  string name_value() 
  { 
    return name + "=" + value; 
  } 
 
  //! Same as @[name_value()] except this URL encodes the value. 
  string name_value_encoded() 
  { 
    return Protocols.HTTP.uri_encode(name) + "=" + 
      Protocols.HTTP.uri_encode(value); 
  } 
 
  //! Comparer method. Checks if @[other] equals this object 
  //! 
  //! @param other 
  protected int(0..1) `==(mixed other) 
  { 
    if (!INSTANCE_OF(this, other)) return 0; 
    if (name == other->get_name()) 
      return value == other->get_value(); 
 
    return 0; 
  } 
 
  //! Checks if this object is greater than @[other] 
  //! 
  //! @param other 
  protected int(0..1) `>(mixed other) 
  { 
    if (!INSTANCE_OF(this, other)) return 0; 
    if (name == other->get_name()) 
      return value > other->get_value(); 
 
    return name > other->get_name(); 
  } 
 
  //! Checks if this object is less than @[other] 
  //! 
  //! @param other 
  protected int(0..1) `<(mixed other) 
  { 
    if (!INSTANCE_OF(this, other)) return 0; 
    if (name == other->get_name()) 
      return value < other->get_value(); 
 
    return name < other->get_name(); 
  } 
 
  //! String format method 
  //! 
  //! @param t 
  protected string _sprintf(int t) 
  { 
    return t == 'O' && sprintf("%O(%O,%O)", object_program(this), name, value); 
  } 
 
  protected mixed cast(string how) 
  { 
    switch (how) 
    { 
      case "string": return name_value_encoded(); 
    } 
 
    error("Cant cast %O() to %O\n", this_program, how); 
  } 
 
  //! Makes sure @[v] to set as @[value] is in UTF-8 encoding 
  //! 
  //! @param v 
  private void low_set_value(string v) 
  { 
    value = v; 
 
    // FIXME: String.width can never be less than 8, this this code is 
    // redudant or buggy. 
    if (String.width(value) < 8) { 
      if (mixed e = catch(value = string_to_utf8(value))) { 
        werror("Warning: Auth.low_set_value(%O): string_to_utf8() failed. " 
               "Already encoded?\n%s\n", value, describe_error(e)); 
      } 
    } 
  } 
} 
 
//! Turns a query string into a mapping 
//! 
//! @param query 
mapping query_to_mapping(string query) 
{ 
  mapping m = ([]); 
  if (!query || !sizeof(query)) 
    return m; 
 
  if (query[0] == '?') 
    query = query[1..]; 
 
  foreach (query/"&", string p) { 
    sscanf (p, "%s=%s", string k, string v); 
    m[k] = Protocols.HTTP.uri_decode(v); // FIXME: Shouldn't k be decoded? 
  } 
 
  return m; 
}