Roxen.git/server/modules/tags/insert_cached_href.pike:5690043e0b510e8bd9483e8148527d8f978ae6ca

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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 // This is a roxen module. Copyright © 2000 - 2004, Roxen IS. // #include <module.h> inherit "module"; //<locale-token project="mod_insert_cached_href">LOCALE</locale-token> #define LOCALE(X,Y) _DEF_LOCALE("mod_insert_cached_href",X,Y) constant cvs_version = "$Id: insert_cached_href.pike,v 1.22 2008/03/31 14:19:48 liin Exp $"; constant thread_safe = 1; constant module_type = MODULE_TAG; LocaleString module_name = LOCALE(1, "Tags: Insert cached href"); LocaleString module_doc = LOCALE(2, "This module contains the RXML tag \"insert " "cached-href\". Useful when implementing e.g." " RSS syndication."); #if DEBUG_INSERT_CACHED_HREF #define DWRITE(x) report_debug("INSERT_CACHED_HREF: " + x + "\n") #else #define DWRITE(x) #endif #ifdef THREADS private roxen.BackgroundProcess bg_process; private array(HTTPClient) initiated; /* Contains initiated but unfinished data fetches */ private Thread.Mutex mutex; private Thread.MutexKey mutex_key; #endif constant MAX_REDIRECTS = 5; private HrefDatabase href_database; void create() { defvar("fetch-interval", "5 minutes", LOCALE(3, "Fetch interval"), TYPE_STRING|VAR_MORE, LOCALE(4, "States how often the data of an URL should be updated. " "In seconds, minutes, hours or days.")); defvar("fresh-time", "0", LOCALE(5, "Fresh time"), TYPE_STRING|VAR_MORE, LOCALE(6, "States how long data in the database can be considered fresh enough" " to display. In seconds, minutes, hours or days. As default this" " is 0, which means that this attribute is not used and that there" " are no restrictions on data freshness.")); defvar("ttl", "7 days", LOCALE(7, "Time to live"), TYPE_STRING|VAR_MORE, LOCALE(8, "States how long unrequested data can exist in the database" " before being removed. In seconds, minutes, hours or days.")); defvar("timeout", "10 seconds", LOCALE(9, "Timeout"), TYPE_STRING|VAR_MORE, LOCALE(10, "The timeout when fetching data from a server. In seconds, minutes, " "hours or days.")); defvar("update-interval", "1 minute", LOCALE(11, "Update interval"), TYPE_STRING|VAR_MORE, LOCALE(12, "States how often the module will check if the database needs to " "be updated. In seconds, minutes, hours or days.")); defvar("recursion_limit", 2, LOCALE(13, "Maximum recursion depth"), TYPE_INT|VAR_MORE, LOCALE(14,"Maximum number of nested <tt><insert cached-href></tt>'s " "allowed. May be set to zero to disable the limit.")); } void start(int occasion, Configuration conf) { if (occasion == 0) { href_database = HrefDatabase(); #ifdef THREADS initiated = ({}); mutex = Thread.Mutex(); #endif } #ifdef THREADS if (occasion == 2) bg_process && bg_process->stop(); // Check whether setup is ok before scheduling background task if (href_database) { if (href_database->ready_to_run()) { bg_process = roxen.BackgroundProcess(get_time_in_seconds(query("update-interval")), href_database->update_db, 0); } else { report_error("Insert cached href: Failed to initialize SQL tables. " "Permission error?\n"); } } #endif } mapping(string:function) query_action_buttons() { return ([LOCALE(15, "Clear database") : href_database->empty_db]); } void stop() { #ifdef THREADS bg_process && bg_process->stop(); bg_process = 0; mutex_key = mutex->lock(); /* Removing registered callbacks for unfinished data fetches to avoid having the back-end thread call them after the module has been destructed: */ foreach(initiated, HTTPClient client) { client->con->request_ok = 0; client->con->request_fail = 0; } mutex_key = 0; initiated = 0; mutex = 0; #endif href_database = 0; } static int get_time_in_seconds(string input) { input = lower_case((string)input); input = String.trim_whites(input); int pos = 0; int number; string the_rest; for (int i = 0; i < sizeof(input) && is_number(input[i]); i++) { pos++; } number = (int)input[0..(pos - 1)]; the_rest = String.trim_whites(input[pos..(sizeof(input) - 1)]); if (!sizeof(the_rest)) return number; switch(the_rest[0]) { case 'd': return number * 24 * 3600; case 'h': return number * 3600; case 'm': return number * 60; case 's': return number; } return number; } static int(0..1) is_number(int char) { return (char >= 48 && char <= 57) ? 1 : 0; } #ifdef THREADS public int(0..1) already_initiated(string url) { foreach(initiated, HTTPClient client) { if (url == (string)client->url) return 1; } return 0; } #endif public int(0..1) is_redirect(int status) { /* A 304 will never happen since the GET is never conditional. */ if (status >= 300 && status < 400 && status != 304) return 1; return 0; } /* Takes action based on HTTP status codes in reply. Synchronous: */ public string get_result_sync(HTTPClient client, mapping args, mapping header) { if (!is_redirect(client->status) || !MAX_REDIRECTS) return decode_data(client->data(), client->con->headers); int counter; string location = client->con->headers->location; if (!location || !sizeof(location)) return decode_data(client->data(), client->con->headers); DWRITE("Following redirect from " + (string)client->url + " to " + location); args["cached-href"] = location; HTTPClient new_client = HTTPClient(args, header); new_client->orig_url = (string)client->url; new_client->run(); counter++; while (is_redirect(new_client->status) && counter < MAX_REDIRECTS) { location = new_client->con->headers->location; if (!location || !sizeof(location)) return decode_data(new_client->data(), new_client->con->headers); DWRITE("Following redirect from " + (string)new_client->url + " to " + location); args["cached-href"] = location; new_client = HTTPClient(args, header); new_client->orig_url = (string)client->url; new_client->run(); counter++; } return decode_data(new_client->data(), new_client->con->headers); } /* Takes action based on HTTP status codes in reply. Asynchronous: */ public void get_result_async(HTTPClient client, mapping args, mapping header) { if (!is_redirect(client->status)) return; int redirects = client->redirects + 1; string location = client->con->headers->location; if (redirects > MAX_REDIRECTS || !location || !sizeof(location)) return; DWRITE("Following redirect from " + (string)client->url + " to " + location); args["cached-href"] = location; HTTPClient new_client = HTTPClient(args, header); new_client->orig_url = client->orig_url; new_client->redirects = redirects; new_client->run(); } public void|string fetch_url(mapping(string:mixed) to_fetch, void|mapping header) { DWRITE(sprintf("fetch_url(): To fetch: %s, with timeout: %d", to_fetch["url"], to_fetch["timeout"])); mapping(string:mixed) args = (["timeout":to_fetch["timeout"], "cached-href":to_fetch["url"], "sync":to_fetch["sync"]]); object client; #ifdef THREADS mutex_key = mutex->lock(); if (!to_fetch["sync"] && already_initiated(to_fetch["url"])) { mutex_key = 0; return; } client = HTTPClient(args, header); initiated += ({client}); mutex_key = 0; client->orig_url = (string)client->url; client->run(); if (to_fetch["sync"]) return get_result_sync(client, args, header); #else client = Protocols.HTTP.get_url(to_fetch["url"], 0); // In practice a server never runs unthreaded. Keep it // simple and only return when status code < 300: if(client && client->status > 0 && client->status < 300) { string data = decode_data(client->data(), client->headers); href_database->update_data(to_fetch["url"], data); return data; } else return ""; #endif } /* This class represents the database in which the data of the URL:s are stored */ class HrefDatabase { private constant request_table_def = "url VARCHAR(255) NOT NULL," "fetch_interval INT UNSIGNED NOT NULL," "fresh_time INT UNSIGNED NOT NULL," "ttl INT UNSIGNED NOT NULL," "timeout INT UNSIGNED NOT NULL," "time_of_day INT UNSIGNED NOT NULL," "next_fetch INT UNSIGNED," "latest_request INT UNSIGNED," "PRIMARY KEY (url, fetch_interval, " "fresh_time, ttl, timeout, time_of_day)"; private constant data_table_def = "url VARCHAR(255) NOT NULL," "data LONGBLOB," "latest_write INT UNSIGNED," "PRIMARY KEY (url)"; private string request_table; private string data_table; public void create() { // Failure to create tables will lead to zero return values request_table = get_my_table("request", ({request_table_def})); data_table = get_my_table("data", ({data_table_def})); } public void empty_db() { /* Might as well clean up the database in a mutex section, just to be sure. No performance issue since this function is only supposed to be used when the "Clear database" button in the admin interface is pressed. */ #ifdef THREADS mutex_key = mutex->lock(); #endif sql_query("DELETE FROM " + request_table); sql_query("DELETE FROM " + data_table); DWRITE("Database has been emptied."); #ifdef THREADS mutex_key = 0; #endif } public int ready_to_run() { // Only ok to run if both tables are accessible return request_table && data_table && 1; } public void update_db() { DWRITE(sprintf("########### update_db(): Called every %d seconds ##########" , get_time_in_seconds(query("update-interval")))); #ifdef THREADS foreach(initiated, HTTPClient client) { DWRITE("STILL initiated (should be empty!!!!!): " + (string)client->url); } #endif #ifdef OFFLINE // Don't alter entries when running server without network connections. return; #endif remove_old_entrys(); if (!nr_of_requests()) { DWRITE("There are no requests, returning from update_db()"); return; } array(mapping(string:mixed)) to_fetch = urls_to_fetch(); foreach(to_fetch, mapping next) { fetch_url(next, (["x-roxen-recursion-depth":1])); } #ifdef THREADS foreach(initiated, HTTPClient client) { DWRITE("initiated: " + (string)client->url); } #endif DWRITE("----------------- Leaving update_db() ------------------------"); } public string get_data(mapping args, mapping header) { int next_fetch = 0; array(mapping(string:mixed)) result; /* if the tag argument time-of-day is provided, the database column next_fetch needs to be calculated: */ if (args["time-of-day"]) { mapping now = localtime(time()); now["hour"] = 0; now["min"] = 0; now["sec"] = 0; next_fetch = mktime(now) + args["time-of-day"]; if (next_fetch < time()) next_fetch += 24 * 3600; } #ifndef THREADS /* When running unthreaded the database still needs to be kept up-to-date */ remove_old_entrys(); #endif sql_query("UPDATE " + request_table + " SET latest_request=" + time() + " WHERE url='" + args["cached-href"] + "' AND fetch_interval=" + args["fetch-interval"] + " AND fresh_time=" + args["fresh-time"] + " AND ttl=" + args["ttl"] + " AND timeout=" + args["timeout"] + " AND time_of_day=" + args["time-of-day"]); sql_query("INSERT IGNORE INTO " + request_table + " values (%s, %d, %d, %d, %d, %d, %d, %d)", args["cached-href"], args["fetch-interval"], args["fresh-time"], args["ttl"], args["timeout"], args["time-of-day"], next_fetch, time()); sql_query("INSERT IGNORE INTO " + data_table + " values (%s, '', 0)", args["cached-href"]); result = sql_query("SELECT data FROM " + data_table + " WHERE url='" + args["cached-href"] + "' AND (" + time() + " - latest_write < " + args["fresh-time"] + " OR " + args["fresh-time"] + " = 0)"); if (result && sizeof(result) && result[0]["data"] != "") { DWRITE("get_data(): Returning cached data for " + args["cached-href"]); return utf8_to_string(result[0]["data"]); } else if (!args["pure-db"]) { DWRITE("get_data(): No cached data existed for " + args["cached-href"] + " so performing a synchronous fetch"); string data = fetch_url((["url":args["cached-href"], "timeout":args["timeout"], "sync":1]), header); return data; } else { DWRITE("get_data(): No cached data existed for " + args["cached-href"] + " and pure-db data " "was desired, so simply returning the empty string"); return ""; } } private array(mapping(string:mixed)) no_duplicate_add(array(mapping(string:mixed)) to_fetch, string url, int timeout) { foreach(to_fetch, mapping one) { if (search(one, url)) return to_fetch; } to_fetch += ({(["url":url, "timeout":timeout])}); return to_fetch; } private int nr_of_requests() { return sizeof(sql_query("SELECT url from " + request_table)); } private void remove_old_entrys() { sql_query("DELETE FROM " + request_table + " WHERE " + time() + " - latest_request " "> ttl"); sql_query("DELETE " + data_table + " FROM " + data_table + " LEFT JOIN " + request_table + " ON " + data_table + ".url=" + request_table + ".url WHERE " + request_table + ".url IS NULL"); } private array(mapping(string:mixed)) urls_to_fetch() { array(mapping(string:mixed)) to_fetch = ({}); array(mapping(string:mixed)) result = sql_query("SELECT " + data_table + ".url, " + request_table + ".timeout FROM " + data_table + " LEFT JOIN " + request_table + " ON " + data_table + ".url=" + request_table + ".url WHERE " + data_table + ".data='' ORDER BY " "url, timeout DESC"); foreach(result, mapping row) { to_fetch = no_duplicate_add(to_fetch, row["url"], 0); } result = sql_query("SELECT " + data_table + ".url, " + request_table + ".timeout, " + data_table + ".latest_write, " + request_table + ".fetch_interval FROM " + data_table + " LEFT JOIN " + request_table + " ON " + data_table + ".url=" + request_table + ".url WHERE " + data_table + ".data!='' AND " + request_table + ".fetch_interval > 0 AND ((" + time() + " - " + data_table + ".latest_write) > " + request_table + ".fetch_interval) ORDER BY " "url, timeout DESC"); foreach(result, mapping row) { to_fetch = no_duplicate_add(to_fetch, row["url"], 0); } result = sql_query("SELECT " + data_table + ".url, " + request_table + ".timeout, " + request_table + ".time_of_day, " + request_table + ".next_fetch FROM " + data_table + " LEFT JOIN " + request_table + " ON " + data_table + ".url=" + request_table + ".url WHERE " + data_table + ".data!='' AND " + request_table + ".time_of_day > 0 AND " + time() + " > " + request_table + ".next_fetch ORDER BY url, timeout DESC"); foreach(result, mapping row) { to_fetch = no_duplicate_add(to_fetch, row["url"], 0); } result = sql_query("SELECT url, max(timeout) FROM " + request_table + " AS url GROUP BY url"); foreach(to_fetch, mapping one) { foreach(result, mapping row) { if (one["url"] == row["url"]) { one["timeout"] = (int)row["max(timeout)"]; break; } } } return to_fetch; } public void update_data(string url, string data) { DWRITE(sprintf("update_data(): Saving the fetched data to the db for url %s" , url)); sql_query("UPDATE " + data_table + " SET data=%s, latest_write=%d WHERE url=%s", string_to_utf8(data), time(), url); sql_query("UPDATE " + request_table + " SET next_fetch=next_fetch + " + (24 * 3600) + " WHERE time_of_day > 0 AND " + time() + " > next_fetch AND url='" + url + "'"); } } /* This class represents a set of attributes given to the tag 'insert cached-href' */ class Attributes { private mapping orig_args; /* The attributes given to the tag */ private mapping db_args; /* Checked attributes with relevance for the database */ void create(mapping args) { orig_args = args; db_args = (["cached-href" : 0, "fetch-interval" : 0, "fresh-time" : 0, "ttl" : 0, "timeout" : 0, "time-of-day" : 0, "pure-db" : 0]); check_args(); } private int(0..1) valid_arg(string arg) { arg = String.trim_whites(arg); if (!sizeof(arg) || !is_number(arg[0]) || arg[0] == 48) return 0; return 1; } private void check_args() { if (orig_args["cached-href"][0..6] != "http://" && orig_args["cached-href"][0..7] != "https://") RXML.run_error("An invalid URL has been provided"); else db_args["cached-href"] = orig_args["cached-href"]; if (orig_args["time-of-day"] && orig_args["fetch-interval"]) RXML.run_error("Supply either time-of-day or fetch-interval, not both"); if (orig_args["time-of-day"]) { if (sizeof(orig_args["time-of-day"]) != 5) RXML.run_error("Wrong timeformat. The correct format is hh:mm"); if (orig_args["time-of-day"][2] != ':') RXML.run_error("Wrong timeformat. The correct format is hh:mm"); int hour = (int)orig_args["time-of-day"][0..1]; int minute = (int)orig_args["time-of-day"][3..4]; if (hour < 0 || hour > 23 || minute < 0 || minute > 59) RXML.run_error("Hour must be between 0 and 23, minutes between 0 and 59"); db_args["time-of-day"] = hour * 3600 + minute * 60; } else if (orig_args["fetch-interval"] && valid_arg(orig_args["fetch-interval"])) { db_args["fetch-interval"] = orig_args["fetch-interval"]; } else { db_args["fetch-interval"] = query("fetch-interval"); } if (orig_args["fresh-time"] && (valid_arg(orig_args["fresh-time"]) || orig_args["fresh-time"] == "0")) db_args["fresh-time"] = orig_args["fresh-time"]; else db_args["fresh-time"] = query("fresh-time"); if (orig_args["ttl"] && valid_arg(orig_args["ttl"])) db_args["ttl"] = orig_args["ttl"]; else db_args["ttl"] = query("ttl"); if (orig_args["timeout"] && valid_arg(orig_args["timeout"])) db_args["timeout"] = orig_args["timeout"]; else db_args["timeout"] = query("timeout"); db_args["fetch-interval"] = get_time_in_seconds(db_args["fetch-interval"]); db_args["fresh-time"] = get_time_in_seconds(db_args["fresh-time"]); db_args["ttl"] = get_time_in_seconds(db_args["ttl"]); db_args["timeout"] = get_time_in_seconds(db_args["timeout"]); if (orig_args["pure-db"]) db_args["pure-db"] = 1; } public mapping get_orig_args() { return orig_args; } public mapping get_db_args() { return db_args; } } class TagInsertCachedHref { inherit RXML.Tag; constant name = "insert"; constant plugin_name = "cached-href"; string get_data(string var, mapping args, RequestID id) { int recursion_depth = (int)id->request_headers["x-roxen-recursion-depth"]; if (query("recursion_limit") && (recursion_depth >= query("recursion_limit"))) RXML.run_error("Too deep insert cached-href recursion."); // Verify that database connection is working if (!href_database || !href_database->ready_to_run()) RXML.run_error("Insert cached href: Database connection not working. " "Permission problems?\n"); recursion_depth++; if(args->nocache) NOCACHE(); else CACHE(60); string res = href_database->get_data(Attributes(args)->get_db_args(), (["x-roxen-recursion-depth":recursion_depth])); // DEPRECATED attribute 'decode-xml'. Keep it during transition period for upgrades, // since there will be undecoded data in the database until the first fetch for each // URL. The same type of decoding now occur upon saving the data in the database if(args["decode-xml"]) { // Parse xml header and recode content to internal representation. mixed result = catch { res = Parser.XML.Simple()->autoconvert(res); }; // Remove any bytes potentially still preceeding the first '<' in the xml file return res[search(res, "<")..]; } return res; } } #ifdef THREADS /* This class represents the retrieval of data from an URL */ class HTTPClient { int status, timeout, start_time, redirects; object con; Standards.URI url; string path, query, orig_url; mapping request_headers; Thread.Queue queue = Thread.Queue(); int(0..1) sync; void create(mapping args, void|mapping _request_headers) { timeout = args["timeout"]; sync = args["sync"]; con = Protocols.HTTP.Query(); if(!_request_headers) request_headers = ([]); else request_headers = _request_headers; if (mixed err = catch (url=Standards.URI(args["cached-href"]))) RXML.parse_error ("Invalid URL: %s\n", describe_error (err)); #if constant(SSL.sslfile) if(url->scheme!="http" && url->scheme!="https") error("Protocols.HTTP can't handle %O or any other protocols than HTTP or HTTPS\n", url->scheme); con->https= (url->scheme=="https")? 1 : 0; #else if(url->scheme!="http" ) error("Protocols.HTTP can't handle %O or any other protocol than HTTP\n", url->scheme); #endif if(!request_headers) request_headers = ([]); mapping default_headers = ([ "user-agent" : "Mozilla/4.0 compatible (Pike HTTP client)", "host" : sprintf("%s:%d", url->host, url->port) ]); if(url->user || url->passwd) default_headers->authorization = "Basic " + MIME.encode_base64(url->user + ":" + (url->password || "")); request_headers = default_headers | request_headers; query=url->query; path=url->path; if(path=="") path="/"; } string data() { if(!con->ok) return ""; if(status > 0 && status < 300) return con->data(); return ""; } void req_ok() { DWRITE("Received headers from " + (string)url + " OK"); status = con->status; /* Error, abort: */ if (status >= 400) { DWRITE("HTTP status code " + (string)status + " for " + (string)url + ", aborting."); finish_up(); if (sync) queue->write("@"); return; } /* Redirection: */ if (is_redirect(status)) { finish_up(); if (sync) { queue->write("@"); return; } mapping args = (["cached-href" : (string)url, "timeout" : timeout, "sync" : 0]); get_result_async(this_object(), args, request_headers); return; } /* HTTP status code OK, continuing with data fetch: */ int data_timeout = timeout - (time() - start_time); con->data_timeout = data_timeout >= 0 ? data_timeout : 0; con->timed_async_fetch(data_ok, data_fail); } void req_fail() { DWRITE("Receiving headers from " + (string)url + " FAILED"); status = 0; finish_up(); if (sync) queue->write("@"); } void data_ok() { DWRITE("Received data from " + (string)url + " OK"); status = con->status; finish_up(); if (href_database) if (orig_url) href_database->update_data(orig_url, decode_data(con->data(), con->headers)); else href_database->update_data((string)url, decode_data(con->data(), con->headers)); if (sync) queue->write("@"); } void data_fail() { DWRITE("Receiving data from " + (string)url + " FAILED"); status = 0; finish_up(); if (sync) queue->write("@"); } private void finish_up() { mutex_key = mutex->lock(); initiated -= ({this_object()}); mutex_key = 0; } void run() { con->set_callbacks(req_ok, req_fail); con->timeout = timeout; start_time = time(); con->async_request(url->host,url->port, "GET "+path+(query?("?"+query):"")+" HTTP/1.0", request_headers); status = con->status; if (sync) { DWRITE("Initiating synchronous fetch for " + (string)url); queue->read(); DWRITE("Synchronous fetch for " + (string)url + " completed."); } } } #endif /* Decodes data based on 1) HTTP headers or 2) fallbacks on data content, meta http-equiv for html and BOM + encoding='' for xml */ string decode_data(string data, mapping headers) { if (data == "" || !headers) return data; function get_ct_cs = lambda(string ct) { string cs; foreach((ct/";")[1..], string s) { string s2 = String.trim_all_whites(s); string _cs; if(sscanf(s2, "charset=%s", _cs) == 1) cs = String.trim_all_whites(_cs); } return cs; }; function get_cs_from_html = lambda(string data) { string cs; Parser.HTML parser = Parser.HTML(); parser->case_insensitive_tag(1); parser->lazy_entity_end(1); parser->ignore_unknown(1); parser->match_tag(0); parser->add_tags( ([ "meta": lambda( Parser.HTML p, mapping m) { if(m["content"] && m["http-equiv"] && lower_case(m["http-equiv"]) == "content-type") cs = get_ct_cs(m["content"]); } ]) ); parser->finish(data); return cs; }; function get_cs_from_xml_enc = lambda(string data) { string cs,tmp; sscanf(data, "%*s<?xml%s?>%*s", tmp); sscanf(lower_case(tmp), "%*sencoding=\"%s\"%*s", cs); if (!cs) cs = "utf-8"; // UTF-8 is default XML encoding when omitted return cs; }; string ct, cs; if(!(ct = headers["content-type"])) { // Don't even try to decode, might be binary for all we know return data; } ct = String.trim_all_whites(lower_case(ct)); // If text, look for charset: if(has_prefix(ct,"text/") || has_prefix(ct, "application/xml")) { cs = get_ct_cs(ct); if (!cs) { // No charset in content-type header, look in data for encoding hints if(has_prefix(ct, "text/html")) { cs = get_cs_from_html(data); } else if(has_prefix(ct, "text/xml") || has_prefix(ct, "application/xml")) { string data2; mixed result = catch { data2 = Parser.XML.Simple()->autoconvert(data); }; if (!result) return remove_bom(data2); cs = get_cs_from_xml_enc(data); } } } if(has_prefix(ct, "text/xml") || has_prefix(ct, "application/xml")) data = remove_bom(data); if(cs) { catch { data = Locale.Charset.decoder(cs)->feed(data)->drain(); return data; }; } return data; } string remove_bom(string data) { return data[search(data, "<")..]; } TAGDOCUMENTATION; #ifdef manual constant tagdoc=([ "insert#cached-href":#"<desc type='plugin'> <short>This tag inserts the contents of the provided URL, as read from a database.</short> The database is updated repeatedly in the background by a background process that is initiated and run as soon as this module is loaded. If the database is empty when the tag is executed, the standard behavior is to fetch the data immediately. When providing values for the attributes fetch-interval, fresh-time, ttl, update-interval or timeout, the time can either be seconds, minutes, hours or days. If only a number is provided, it is interpreted as seconds, otherwise write the corresponding letter or word after the number, e.g: 10 days, 10d, 10 h, 10hours, 5 min, 5m, 2 hours and so on. Spaces between the number and the word are allowed. The values at the settings tab for fetch-interval, fresh-time, ttl and timeout are the standard values that the tag will be assigned if an attribute is left out. update-interval on the other hand, is central and common for all tags. <note> The data in the database for an URL is always shared by all tags at the same site. This means that when data for an URL is updated this affects all tags referring to this specific URL, even if the other attributes may differ. For example, if the same URL is referenced by one tag without the pure-db attribute and another tag WITH the pure-db attribute, the only guarantee is that the tag with the attribute pure-db never will generate a data fetch. The tag without the attribute still can. Another implication of the data being shared is for example if the same URL is referenced by two tags with different fetch intervals. The data will then be updated at the smallest of these two fetch intervals. Providing the time-of-day attribute will however always make the module fetch data when that time of day occur, without interference by any other tag referencing the same URL. Also important to note, is that since the fetching of the common data is performed centrally by the module, the timeout of every tag can not be used, of course. If several tags refer to the same URL but are provided with different timeouts, the longest timeout will be used. However, if there exists no data in the database for the URL of a tag when the tag is run, and the pure-db attribute is not provided, then the fetching of data will be performed for that specific tag and with the specified timeout. </note> </desc> <attr name='cached-href' value='string'> The URL of the page to be inserted. </attr> <attr name='fetch-interval' value='string'> States at what interval the background process will fetch the URL and update the database. </attr> <attr name='time-of-day' value='string'> Can be provided as an alternative to fetch-interval, if a fetch should be performed once per day at a specific time. The provided time must be of the format hh:mm. </attr> <attr name='fresh-time' value='string'> States how long the data for the URL in the database is considered fresh. </attr> <attr name='ttl' value='string'> States how long unrequested data will exist in the database before being removed. </attr> <attr name='timeout' value='string'> The timeout for the fetching of new data from a server. </attr> <attr name='pure-db'> If provided, the tag will only return data stored in the database, i.e never fetch data immediately if the database is empty. Instead, the data will not be available until the background process has updated the database. </attr> <attr name='nocache' value='string'> If provided the resulting page will get a zero cache time in the RAM cache. The default time is up to 60 seconds depending on the cache limit imposed by other RXML tags on the same page. </attr> <attr name='decode-xml' value='string'> (DEPRECATED. All text content is now decoded automatically.) If provided the resulting content will be decoded to the internal charset representation by looking at a potential BOM (Byte Order Mark) and the specified encoding in the XML header. Defaults to UTF-8 if no BOM or encoding was found. </attr>", ]); #endif

Roxen.git/ server/ modules/ tags/ insert_cached_href.pike > 5690043e0b510e8bd9483e8148527d8f978ae6ca [Annotate]