Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | /fileedit now uses fileStorage or sessionStorage, if available, to store unsaved local edits to the 7 most recently edited checkin/file combinations. TODO: make that configurable and offer a widget to manage that stash and quickly switch between those files. It warns loudly if persistent storage is not available. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | fileedit-ajaxify |
Files: | files | file ages | folders |
SHA3-256: |
d130f3568793a62193d061357b0a8ad1 |
User & Date: | stephan 2020-05-15 18:43:42 |
Context
2020-05-15
| ||
18:54 | Completed a half-written sentence in the fileedit docs. ... (check-in: d701631e user: stephan tags: fileedit-ajaxify) | |
18:43 | /fileedit now uses fileStorage or sessionStorage, if available, to store unsaved local edits to the 7 most recently edited checkin/file combinations. TODO: make that configurable and offer a widget to manage that stash and quickly switch between those files. It warns loudly if persistent storage is not available. ... (check-in: d130f356 user: stephan tags: fileedit-ajaxify) | |
04:40 | Modernized sbsdiff.js a tiny bit, adapted it to optionally be callable multiple times via fossil.page.tweakSbsDiffs(), and activate that when fileedit's sbs diff is refreshed. ... (check-in: dd465796 user: stephan tags: fileedit-ajaxify) | |
Changes
Changes to src/default_css.txt.
︙ | ︙ | |||
885 886 887 888 889 890 891 892 893 894 895 896 897 898 | } .error { color: darkred; background: yellow; } body.fileedit .error { padding: 0.25em; } ////////////////////////////////// // Styles for fossil.tabs.js: .tab-container { width: 100%; display: flex; flex-direction: column; | > > > > > > | 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 | } .error { color: darkred; background: yellow; } body.fileedit .error { padding: 0.25em; } body.fileedit .warning { color: darkred; background: yellow; padding: 0.25em; opacity: 0.6; } ////////////////////////////////// // Styles for fossil.tabs.js: .tab-container { width: 100%; display: flex; flex-direction: column; |
︙ | ︙ |
Changes to src/fileedit.c.
︙ | ︙ | |||
649 650 651 652 653 654 655 | if(0==fossil_strcmp(zFilePrev->zUuid, blob_str(&pCI->fileHash)) && manifest_file_mperm(zFilePrev)==pCI->filePerm){ ci_err((pErr,"File is unchanged. Not saving.")); } } #if 1 /* Do we really want to normalize comment EOLs? Web-posting will | | > > | 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | if(0==fossil_strcmp(zFilePrev->zUuid, blob_str(&pCI->fileHash)) && manifest_file_mperm(zFilePrev)==pCI->filePerm){ ci_err((pErr,"File is unchanged. Not saving.")); } } #if 1 /* Do we really want to normalize comment EOLs? Web-posting will ** submit them in CRLF or LF format, depending on how exactly the ** content is submitted (FORM (CRLF) or textarea-to-POST (LF, at ** least in theory)). */ blob_to_lf_only(&pCI->comment); #endif /* Create, save, deltify, and crosslink the manifest... */ if(create_manifest_mini(&mf, pCI, pErr)==0){ return 0; } isPrivate = content_is_private(pCI->pParent->rid); |
︙ | ︙ | |||
1470 1471 1472 1473 1474 1475 1476 | } if(p_int("allow_fork")!=0){ p->flags |= CIMINI_ALLOW_FORK; } if(p_int("allow_older")!=0){ p->flags |= CIMINI_ALLOW_OLDER; } | | > > | 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 | } if(p_int("allow_fork")!=0){ p->flags |= CIMINI_ALLOW_FORK; } if(p_int("allow_older")!=0){ p->flags |= CIMINI_ALLOW_OLDER; } if(0==p_int("exec_bit")){ p->filePerm = PERM_REG; }else{ p->filePerm = PERM_EXE; } if(p_int("allow_merge_conflict")!=0){ p->flags |= CIMINI_ALLOW_MERGE_MARKER; } if(p_int("prefer_delta")!=0){ p->flags |= CIMINI_PREFER_DELTA; |
︙ | ︙ | |||
1605 1606 1607 1608 1609 1610 1611 | ** ** comment_mimetype=text ** dry_run=int (1 or 0) ** ** ** User must have Write access to use this page. ** | | > > | > | > | > > | 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 | ** ** comment_mimetype=text ** dry_run=int (1 or 0) ** ** ** User must have Write access to use this page. ** ** Responds with JSON (with some state repeated ** from the input in order to avoid certain race conditions ** client-side): ** ** { ** checkin: newUUID, ** filename: theFilename, ** mimetype: string, ** isExe: bool, ** dryRun: bool, ** manifest: text of manifest, ** } ** ** On error it produces a JSON response as documented for ** fileedit_ajax_error(). */ static void fileedit_ajax_commit(void){ Blob err = empty_blob; /* Error messages */ Blob manifest = empty_blob; /* raw new manifest */ CheckinMiniInfo cimi; /* checkin state */ int rc; /* generic result code */ int newVid = 0; /* new version's RID */ char * zNewUuid = 0; /* newVid's UUID */ char const * zMimetype; if(!fileedit_ajax_boostrap()){ return; } db_begin_transaction(); CheckinMiniInfo_init(&cimi); rc = fileedit_setup_cimi_from_p(&cimi, &err, 0); |
︙ | ︙ | |||
1648 1649 1650 1651 1652 1653 1654 | fileedit_ajax_error(500,"%b",&err); goto end_cleanup; } assert(newVid>0); zNewUuid = rid_to_uuid(newVid); cgi_set_content_type("application/json"); CX("{"); | | > > > > > > | 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 | fileedit_ajax_error(500,"%b",&err); goto end_cleanup; } assert(newVid>0); zNewUuid = rid_to_uuid(newVid); cgi_set_content_type("application/json"); CX("{"); CX("\"checkin\":%!j,", zNewUuid); CX("\"filename\":%!j,", cimi.zFilename); CX("\"isExe\": %s,", cimi.filePerm==PERM_EXE ? "true" : "false"); zMimetype = mimetype_from_name(cimi.zFilename); if(zMimetype!=0){ CX("\"mimetype\": %!j,", zMimetype); } CX("\"dryRun\": %s,", (CIMINI_DRY_RUN & cimi.flags) ? "true" : "false"); CX("\"manifest\": %!j", blob_str(&manifest)); CX("}"); db_end_transaction(0/*noting that dry-run mode will have already ** set this to rollback mode. */); end_cleanup: |
︙ | ︙ | |||
1821 1822 1823 1824 1825 1826 1827 | "editor_font_size", "Editor font size", NULL/*tooltip*/, 100, "100%", 100, "125%", 125, "150%", 150, "175%", 175, "200%", 200, NULL); CX("</div>"); | | < | 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 | "editor_font_size", "Editor font size", NULL/*tooltip*/, 100, "100%", 100, "125%", 125, "150%", 150, "175%", 175, "200%", 200, NULL); CX("</div>"); CX("<div class='flex-container flex-column'>"); CX("<textarea name='content' id='fileedit-content-editor' " "class='fileedit' " "rows='20' cols='80'>"); CX("</textarea>"); CX("</div>"/*textarea wrapper*/); CX("</div>"/*#tab-file-content*/); } /****** Preview tab ******/ { |
︙ | ︙ | |||
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 | CX("<li>\"Delta manifests\" (see the checkbox on the Commit tab) " "make for smaller commit records, especially in repositories " "with many files.</li>"); CX("<li>The file selector allows, for usability's sake, only files " "in leaf checkins to be selected, but files may be edited via " "non-leaf checkins by passing them as the <code>filename</code> " "and <code>checkin</code> URL arguments to this page.</li>"); CX("</ul>"); } CX("</div>"/*#fileedit-tab-help*/); { /* Dynamically populate the editor, display any error in the err ** blob, and/or switch to tab #0, where the file selector | > > > > > > > | 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 | CX("<li>\"Delta manifests\" (see the checkbox on the Commit tab) " "make for smaller commit records, especially in repositories " "with many files.</li>"); CX("<li>The file selector allows, for usability's sake, only files " "in leaf checkins to be selected, but files may be edited via " "non-leaf checkins by passing them as the <code>filename</code> " "and <code>checkin</code> URL arguments to this page.</li>"); CX("<li>The editor \"stashes\" local edits to the last 7 " "checkin/file combinations in one of " "<code>window.fileStorage</code> or " "<code>window.sessionStorage</code>, if able, but which storage " "is unspecified and may differ across environments. When saving " "or force-reloading a file, stashed edits to that version are " "discarded.</li>"); CX("</ul>"); } CX("</div>"/*#fileedit-tab-help*/); { /* Dynamically populate the editor, display any error in the err ** blob, and/or switch to tab #0, where the file selector |
︙ | ︙ | |||
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 | blob_reset(&err); CheckinMiniInfo_cleanup(&cimi); style_emit_script_fossil_bootstrap(0); append_diff_javascript(1); style_emit_script_fetch(0); style_emit_script_tabs(0)/*also emits fossil.dom*/; style_emit_script_confirmer(0); style_emit_script_builtin(0, "fossil.page.fileedit.js"); if(blob_size(&endScript)>0){ style_emit_script_tag(0,0); CX("(function(){\n"); CX("try{\n%b\n}" "catch(e){" "fossil.error(e);\n" | > | 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 | blob_reset(&err); CheckinMiniInfo_cleanup(&cimi); style_emit_script_fossil_bootstrap(0); append_diff_javascript(1); style_emit_script_fetch(0); style_emit_script_tabs(0)/*also emits fossil.dom*/; style_emit_script_confirmer(0); style_emit_script_builtin(0, "fossil.storage.js"); style_emit_script_builtin(0, "fossil.page.fileedit.js"); if(blob_size(&endScript)>0){ style_emit_script_tag(0,0); CX("(function(){\n"); CX("try{\n%b\n}" "catch(e){" "fossil.error(e);\n" |
︙ | ︙ |
Changes to src/fossil.page.fileedit.js.
︙ | ︙ | |||
12 13 14 15 16 17 18 | { filename: string, checkin: UUID string, isExe: bool, mimetype: mimetype stringas determined by the fossil server. } | | | 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | { filename: string, checkin: UUID string, isExe: bool, mimetype: mimetype stringas determined by the fossil server. } The fossil.page.fileContent() method gets or sets the current file content for the page. Hypothetically, this can be overridden by skin-level JS in order to use a custom 3rd-party editing widget in place of the built-in textarea, but that is as yet untested. In order to do so the client would need to replace DOM element #fileedit-content-editor with their custom widget. - Event 'fileedit-preview-updated': when the preview is refreshed |
︙ | ︙ | |||
204 205 206 207 208 209 210 211 212 213 214 215 216 217 | btnReload.addEventListener( 'click', (e)=>this.loadLeaves(), false ); delete this.init; } }/*P.fileSelector*/; /** Internal workaround to select the current preview mode and fire a change event if the value actually changes or if forceEvent is truthy. */ P.selectPreviewMode = function(modeValue, forceEvent){ const s = this.e.selectPreviewMode; | > | 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | btnReload.addEventListener( 'click', (e)=>this.loadLeaves(), false ); delete this.init; } }/*P.fileSelector*/; /** Internal workaround to select the current preview mode and fire a change event if the value actually changes or if forceEvent is truthy. */ P.selectPreviewMode = function(modeValue, forceEvent){ const s = this.e.selectPreviewMode; |
︙ | ︙ | |||
310 311 312 313 314 315 316 | "click",(e)=>P.diff(false), false ); P.e.btnCommit.addEventListener( "click",(e)=>P.commit(), false ); F.confirmer(P.e.btnReload, { confirmText: "Really reload, losing edits?", | | > > > > > > > | 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 | "click",(e)=>P.diff(false), false ); P.e.btnCommit.addEventListener( "click",(e)=>P.commit(), false ); F.confirmer(P.e.btnReload, { confirmText: "Really reload, losing edits?", onconfirm: (e)=>P.unstashContent().loadFile(), ticks: 3 }); E('#comment-toggle').addEventListener( "click",(e)=>P.toggleCommentMode(), false ); P.e.taEditor.addEventListener( 'change', ()=>P.stashContentChange(), false ); P.e.cbIsExe.addEventListener( 'change', ()=>P.stashContentChange(true), false ); /** Cosmetic: jump through some hoops to enable/disable certain preview options depending on the current preview mode... */ P.e.selectPreviewMode.addEventListener( "change", function(e){ |
︙ | ︙ | |||
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 | if(0){ // only for testing P.addEventListener( 'fileedit-file-loaded', (e)=>console.debug('fileedit-file-loaded ==>',e) ); } }, false)/*onload event handler*/; /** Getter (if called with no args) or setter (if passed an arg) for the current file content. We use a function, rather than direct access, so that clients can hypothetically swap out this method from their skin in order to facilitate plugging-in of a fancy 3rd-party editor widget. The setter form returns this object, and re-implementations must do the same. */ | > > > > > > > > > > > > > > > > > > > | | | 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 | if(0){ // only for testing P.addEventListener( 'fileedit-file-loaded', (e)=>console.debug('fileedit-file-loaded ==>',e) ); } /* Tell the user about which storage is being used... */ const storageMsgTarget = P.e.tabs.content; let storageMsg = D.addClass(D.div(),'flex-container','flex-row', 'fileedit-hint'); if(F.storage.isTransient()){ D.append( D.addClass(storageMsg,'warning'), "Warning: persistent storage is not avaible, "+ "so unsaved edits "+ "will not survive a page reload." ); }else{ D.append( storageMsg, "Current storage mechanism for local edits: "+ F.storage.storageImplName() ); } storageMsgTarget.insertBefore(storageMsg, storageMsgTarget.lastElementChild); }, false)/*onload event handler*/; /** Getter (if called with no args) or setter (if passed an arg) for the current file content. We use a function, rather than direct access, so that clients can hypothetically swap out this method from their skin in order to facilitate plugging-in of a fancy 3rd-party editor widget. The setter form returns this object, and re-implementations must do the same. */ P.fileContent = function(){ if(0===arguments.length){ return this.e.taEditor.value; }else{ this.e.taEditor.value = arguments[0] || ''; return this; } }; /** If either of... |
︙ | ︙ | |||
455 456 457 458 459 460 461 | */ c = c.replace(/\r?\n/g,' '); } s.value = c; this.e.taComment = s; D.addClass(h, 'hidden'); D.removeClass(s, 'hidden'); | < > > > | > | > | 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 | */ c = c.replace(/\r?\n/g,' '); } s.value = c; this.e.taComment = s; D.addClass(h, 'hidden'); D.removeClass(s, 'hidden'); }; /** Returns true if fossil.page.finfo is set, indicating that a file has been loaded, else it reports an error and returns false. If passed a truthy value any error message about not having a file loaded is suppressed. */ const affirmHasFile = function(quiet){ if(!P.finfo){ if(!quiet) F.error("No file is loaded."); } return !!P.finfo; }; /** updateVersion() updates the filename and version in various UI elements... |
︙ | ︙ | |||
561 562 563 564 565 566 567 | */ P.loadFile = function(file,rev){ if(0===arguments.length){ if(!affirmHasFile()) return this; file = this.finfo.filename; rev = this.finfo.checkin; } | < > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > | < < | < < < < | < < | 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 | */ P.loadFile = function(file,rev){ if(0===arguments.length){ if(!affirmHasFile()) return this; file = this.finfo.filename; rev = this.finfo.checkin; } const self = this; const onload = (r,headers)=>{ delete self.finfo; self.updateVersion({ filename: file, checkin: rev, isExe: ('x'===headers['x-fileedit-file-perm']), mimetype: headers['content-type'].split(';').shift() }); self.tabs.switchToTab(self.e.tabs.content); self.e.cbIsExe.checked = self.finfo.isExe; self.fileContent(r); self.dispatchEvent('fileedit-file-loaded', self.finfo); }; const semiFinfo = {filename: file, checkin: rev}; const stashFinfo = this.getStashedFinfo(semiFinfo); if(stashFinfo){ // fake a response from the stash... this.finfo = stashFinfo; this.e.cbIsExe.checked = !!stashFinfo.isExe; onload(this.contentFromStash()||'',{ 'x-fileedit-file-perm': stashFinfo.isExe ? 'x' : undefined, 'content-type': stashFinfo.mimetype }); F.message("Fetched from the local-edit stash:", F.hashDigits(stashFinfo.checkin), stashFinfo.filename); return this; } F.message( "Loading content..." ).fetch('fileedit',{ urlParams: { ajax: 'content', filename:file, checkin:rev }, responseHeaders: ['x-fileedit-file-perm', 'content-type'], onload:(r,headers)=>{ onload(r,headers); F.message('Loaded content for', F.hashDigits(self.finfo.checkin), self.finfo.filename); } }); return this; }; /** Fetches the page preview based on the contents and settings of |
︙ | ︙ | |||
604 605 606 607 608 609 610 | const target = this.e.previewTarget, self = this; const updateView = function(c){ D.clearElement(target); if('string'===typeof c) target.innerHTML = c; if(switchToTab) self.tabs.switchToTab(self.e.tabs.preview); }; | | | 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | const target = this.e.previewTarget, self = this; const updateView = function(c){ D.clearElement(target); if('string'===typeof c) target.innerHTML = c; if(switchToTab) self.tabs.switchToTab(self.e.tabs.preview); }; return this._postPreview(this.fileContent(), updateView); }; /** Callback for use with F.connectPagePreviewers() */ P._postPreview = function(content,callback){ if(!affirmHasFile()) return this; |
︙ | ︙ | |||
656 657 658 659 660 661 662 | Fetches the content diff based on the contents and settings of this page's input fields, and updates the UI with the diff view. Returns this object, noting that the operation is async. */ P.diff = function f(sbs){ if(!affirmHasFile()) return this; | | | 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 | Fetches the content diff based on the contents and settings of this page's input fields, and updates the UI with the diff view. Returns this object, noting that the operation is async. */ P.diff = function f(sbs){ if(!affirmHasFile()) return this; const content = this.fileContent(), self = this; if(!f.target){ f.target = this.e.tabs.diff.querySelector( '#fileedit-tab-diff-wrapper' ); } const fd = new FormData(); |
︙ | ︙ | |||
698 699 700 701 702 703 704 | the UI. Returns this object. */ P.commit = function f(){ if(!affirmHasFile()) return this; const self = this; | | | | > | | > | < | > | > | > < < < < | 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 | the UI. Returns this object. */ P.commit = function f(){ if(!affirmHasFile()) return this; const self = this; const content = this.fileContent(), target = document.querySelector('#fileedit-manifest'), cbDryRun = E('[name=dry_run]'), isDryRun = cbDryRun.checked, filename = this.finfo.filename; if(!f.onload){ f.onload = function(c){ const oldFinfo = JSON.parse(JSON.stringify(self.finfo)) target.innerHTML = [ "<h3>Manifest", (c.dryRun?" (dry run)":""), ": ", F.hashDigits(c.checkin),"</h3>", "<code class='fileedit-manifest'>", c.manifest, "</code></pre>" ].join(''); const msg = [ 'Committed', c.dryRun ? '(dry run)' : '', '[', F.hashDigits(c.checkin) ,'].' ]; if(!c.dryRun){ if(0){ msg.push('Re-activating dry-run mode.'); cbDryRun.checked = true; } self.unstashContent(oldFinfo); delete c.manifest; self.finfo = c; self.e.taComment.value = ''; self.updateVersion(); self.fileSelector.loadLeaves(); } F.message.apply(F, msg); self.tabs.switchToTab(self.e.tabs.commit); }; } const fd = new FormData(); fd.append('filename',filename); fd.append('checkin', this.finfo.checkin); fd.append('content',content); fd.append('dry_run',isDryRun ? 1 : 0); fd.append('eol', this.e.selectEol.value || 0); /* Text fields or select lists... */ |
︙ | ︙ | |||
760 761 762 763 764 765 766 | 'allow_older', 'exec_bit', 'allow_merge_conflict', 'prefer_delta' ].forEach(function(name){ var e = E('[name='+name+']'); if(e){ | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | 'allow_older', 'exec_bit', 'allow_merge_conflict', 'prefer_delta' ].forEach(function(name){ var e = E('[name='+name+']'); if(e){ fd.append(name, e.checked ? 1 : 0); }else{ console.error("Missing checkbox? name =",name); } }); F.message( "Checking in..." ).fetch('fileedit',{ urlParams: {ajax: 'commit'}, payload: fd, responseType: 'json', onload: f.onload }); return this; }; /** $stash is an internal-use-only object for managing "stashed" local edits, to help avoid that users accidentally lose content by switching tabs or following links or some such. The basic theory of operation is... All "stashed" state is stored using fossil.storage. - When the current file content is modified by the user, the current stathe of the current P.finfo and its the content is stashed. For the built-in editor widget, "changes" is notified via a 'change' event. For a client-side custom widget, the client needs to call P.stashContentChange() when their widget triggers the equivalent of a 'change' event. - For certain non-content updates (as of this writing, only the is-executable checkbox), only the P.finfo stash entry is updated, not the content (unless the content has not yet been stashed, in which case it is also stashed so that the stash always has matching pairs of finfo/content). - When saving, the stashed entry for the previous version is removed from the stash. - When "loading", we use any stashed state for the given checkin/file combination. When forcing a re-load of content, any stashed entry for that combination is removed from the stash. - Every time P.stashContentChange() updates the stash, it is pruned to $stash.prune.defaultMaxCount most-recently-updated entries. - This API often refers to "finfo objects." Those are objects with a minimum of {checkin,filename} properties (which must be valid), and a combination of those two properties is used as basis for the stash keys for any given checkin/filename combination. The structure of the stash is a bit convoluted for efficiency's sake: we store a map of file info (finfo) objects separately from those files' contents because otherwise we would be required to JSONize/de-JSONize the file content when stashing/restoring it, and that would be horribly inefficient (meaning "battery-consuming" on mobile devices). */ const $stash = { keys: { index: F.page.name+':index' }, /** index: { "CHECKIN_HASH:FILENAME": {file info w/o content} ... } In F.storage we... - Store this.index under the key this.keys.index. - Store each file's content under the key (P.name+'/CHECKIN_HASH:FILENAME'). These are stored separately from the index entries to avoid having to JSONize/de-JSONize the content. The assumption/hope is that the browser can store those records "directly," without any intermediary encoding/decoding going on. */ indexKey: function(finfo){return finfo.checkin+':'+finfo.filename}, /** Returns the key for storing content for the given key suffix, by prepending P.name to suffix. */ contentKey: function(suffix){return P.name+'/'+suffix}, /** Returns the index object, fetching it from the stash or creating it anew on the first call. */ getIndex: function(){ if(!this.index) this.index = F.storage.getJSON(this.keys.index,{}); return this.index; }, /** Returns the stashed version, if any, for the given finfo object. */ getFinfo: function(finfo){ const ndx = this.getIndex(); return ndx[this.indexKey(finfo)]; }, /** Serializes this object's index to F.storage. Returns this. */ storeIndex: function(){ if(this.index) F.storage.setJSON(this.keys.index,this.index); return this; }, /** Updates the stash record for the given finfo and (optionally) content. If passed 1 arg, only the finfo stash is updated, else both the finfo and its contents are (re-)stashed. Returns this. */ updateFile: function(finfo,content){ const ndx = this.getIndex(), key = this.indexKey(finfo); const record = ndx[key] || (ndx[key]={ checkin: finfo.checkin, filename: finfo.filename, mimetype: finfo.mimetype }); record.isExe = !!finfo.isExe; record.stashTime = new Date().getTime(); this.storeIndex(); if(arguments.length>1){ F.storage.set(this.contentKey(key), content); } return this; }, /** Returns the stashed content, if any, for the given finfo object. */ stashedContent: function(finfo){ return F.storage.get(this.contentKey(this.indexKey(finfo))); }, /** Returns true if we have stashed content for the given finfo record. */ hasStashedContent: function(finfo){ return F.storage.contains(this.contentKey(this.indexKey(finfo))); }, /** Unstashes the given finfo record and its content. Returns this. */ unstash: function(finfo){ const ndx = this.getIndex(), key = this.indexKey(finfo); delete finfo.stashTime; delete ndx[key]; F.storage.remove(this.contentKey(key)); return this.storeIndex(); }, /** Clears all $stash entries from F.storage. Returns this. */ clear: function(){ const ndx = this.getIndex(), self = this; Object.keys(ndx).forEach(function(k){ const e = ndx[k]; delete ndx[k]; F.storage.remove(self.contentKey(k)); }); F.storage.remove(this.keys.index); delete this.index; return this; }, /** Removes all but the maxCount most-recently-updated stash entries, where maxCount defaults to this.prune.defaultMaxCount. */ prune: function f(maxCount){ const ndx = this.getIndex(); const li = []; if(!maxCount || maxCount<0) maxCount = f.defaultMaxCount; Object.keys(ndx).forEach((k)=>li.push(ndx[k])); li.sort((l,r)=>l.stashTime - r.stashTime); while(li.length>maxCount){ const e = li.shift(); this.unstash(e); console.warn("Pruned oldest stash entry:",e); } } }; $stash.prune.defaultMaxCount = 7; /** Updates P.finfo for certain state and stashes P.finfo, with the current content fetched via P.fileContent(). If passed truthy AND the stash already has stashed content for the current file, only the stashed finfo record is updated, else both the finfo and content are updated. */ P.stashContentChange = function(onlyFinfo){ if(affirmHasFile(true)){ const fi = this.finfo; fi.isExe = this.e.cbIsExe.checked; if(onlyFinfo && $stash.hasStashedContent(fi)){ $stash.updateFile(fi); }else{ $stash.updateFile(fi, P.fileContent()); } F.message("Stashed change to",F.hashDigits(fi.checkin),fi.filename); $stash.prune(); } return this; }; /** Removes any stashed state for the current P.finfo (if set) from F.storage. Returns this. */ P.unstashContent = function(){ const finfo = arguments[0] || this.finfo; if(finfo){ $stash.unstash(finfo); //console.debug("Unstashed",finfo); F.message("Unstashed",F.hashDigits(finfo.checkin),finfo.filename); } return this; }; /** Clears all stashed file state from F.storage. Returns this. */ P.clearStash = function(){ $stash.clear(); return this; }; /** If stashed content for P.finfo exists, it is returned, else undefined is returned. */ P.contentFromStash = function(){ return affirmHasFile(true) ? $stash.stashedContent(this.finfo) : undefined; }; /** If a stashed version of the given finfo object exists (same filename/checkin values), return it, else return undefined. */ P.getStashedFinfo = function(finfo){ return $stash.getFinfo(finfo); }; P.$stash = $stash /*only for testing/debugging */; })(window.fossil); |
Added src/fossil.storage.js.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | (function(F){ /** fossil.store is a basic wrapper around localStorage or sessionStorage or a dummy proxy object if neither of those are available. */ const tryStorage = function f(obj){ if(!f.key) f.key = 'fossil.access.check'; try{ obj.setItem(f.key, 'f'); const x = obj.getItem(f.key); obj.removeItem(f.key); if(x!=='f') throw new Error(f.key+" failed") return obj; }catch(e){ return undefined; } }; /** Internal storage impl for fossil.storage. */ const $storage = tryStorage(window.localStorage) || tryStorage(window.sessionStorage) || tryStorage({ // A basic dummy xyzStorage stand-in $:{}, setItem: function(k,v){this.$[k]=v}, getItem: function(k){ return this.$.hasOwnProperty(k) ? this.$[k] : undefined; }, removeItem: function(k){delete this.$[k]}, clear: function(){this.$={}} }); /** A proxy for localStorage or sessionStorage or a page-instance-local proxy, if neither one is availble. Which exact storage implementation is uses is unspecified, and apps must not rely on it. */ fossil.storage = { /** Sets the storage key k to value v, implicitly converting it to a string. */ set: (k,v)=>$storage.setItem(k,v), /** Sets storage key k to JSON.stringify(v). */ setJSON: (k,v)=>$storage.setItem(k,JSON.stringify(v)), /** Returns the value for the given storage key, or dflt if the key is not found in the storage. */ get: (k,dflt)=>$storage.hasOwnProperty(k) ? $storage.getItem(k) : dflt, /** Returns the JSON.parse()'d value of the given storage key's value, or dflt is the key is not found or JSON.parse() fails. */ getJSON: function f(k,dflt){ try { const x = this.get(k,f); return x===f ? dflt : JSON.parse(x); } catch(e){return dflt} }, /** Returns true if the storage contains the given key, else false. */ contains: (k)=>$storage.hasOwnProperty(k), /** Removes the given key from the storage. */ remove: (k)=>$storage.removeItem(k), /** Clears ALL keys from the storage. */ clear: ()=>$storage.clear(), /** Returns an array of all keys currently in the storage. */ keys: ()=>Object.keys($storage), /** Returns true if this storage is transient (only available until the page is reloaded), indicating that fileStorage and sessionStorage are unavailable. */ isTransient: ()=>!($storage===window.localStorage ||$storage===window.sessionStorage), /** Returns a symbolic name for the current storage mechanism. */ storageImplName: function(){ if($storage===window.localStorage) return 'localStorage'; else if($storage===window.sessionStorage) return 'sessionStorage'; else return 'transient'; } }; })(window.fossil); |
Changes to src/main.mk.
︙ | ︙ | |||
222 223 224 225 226 227 228 229 230 231 232 233 234 235 | $(SRCDIR)/diff.tcl \ $(SRCDIR)/forum.js \ $(SRCDIR)/fossil.bootstrap.js \ $(SRCDIR)/fossil.confirmer.js \ $(SRCDIR)/fossil.dom.js \ $(SRCDIR)/fossil.fetch.js \ $(SRCDIR)/fossil.page.fileedit.js \ $(SRCDIR)/fossil.tabs.js \ $(SRCDIR)/graph.js \ $(SRCDIR)/href.js \ $(SRCDIR)/login.js \ $(SRCDIR)/markdown.md \ $(SRCDIR)/menu.js \ $(SRCDIR)/sbsdiff.js \ | > | 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | $(SRCDIR)/diff.tcl \ $(SRCDIR)/forum.js \ $(SRCDIR)/fossil.bootstrap.js \ $(SRCDIR)/fossil.confirmer.js \ $(SRCDIR)/fossil.dom.js \ $(SRCDIR)/fossil.fetch.js \ $(SRCDIR)/fossil.page.fileedit.js \ $(SRCDIR)/fossil.storage.js \ $(SRCDIR)/fossil.tabs.js \ $(SRCDIR)/graph.js \ $(SRCDIR)/href.js \ $(SRCDIR)/login.js \ $(SRCDIR)/markdown.md \ $(SRCDIR)/menu.js \ $(SRCDIR)/sbsdiff.js \ |
︙ | ︙ |
Changes to win/Makefile.mingw.
︙ | ︙ | |||
644 645 646 647 648 649 650 651 652 653 654 655 656 657 | $(SRCDIR)/diff.tcl \ $(SRCDIR)/forum.js \ $(SRCDIR)/fossil.bootstrap.js \ $(SRCDIR)/fossil.confirmer.js \ $(SRCDIR)/fossil.dom.js \ $(SRCDIR)/fossil.fetch.js \ $(SRCDIR)/fossil.page.fileedit.js \ $(SRCDIR)/fossil.tabs.js \ $(SRCDIR)/graph.js \ $(SRCDIR)/href.js \ $(SRCDIR)/login.js \ $(SRCDIR)/markdown.md \ $(SRCDIR)/menu.js \ $(SRCDIR)/sbsdiff.js \ | > | 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 | $(SRCDIR)/diff.tcl \ $(SRCDIR)/forum.js \ $(SRCDIR)/fossil.bootstrap.js \ $(SRCDIR)/fossil.confirmer.js \ $(SRCDIR)/fossil.dom.js \ $(SRCDIR)/fossil.fetch.js \ $(SRCDIR)/fossil.page.fileedit.js \ $(SRCDIR)/fossil.storage.js \ $(SRCDIR)/fossil.tabs.js \ $(SRCDIR)/graph.js \ $(SRCDIR)/href.js \ $(SRCDIR)/login.js \ $(SRCDIR)/markdown.md \ $(SRCDIR)/menu.js \ $(SRCDIR)/sbsdiff.js \ |
︙ | ︙ |
Changes to win/Makefile.msc.
︙ | ︙ | |||
551 552 553 554 555 556 557 558 559 560 561 562 563 564 | $(SRCDIR)\diff.tcl \ $(SRCDIR)\forum.js \ $(SRCDIR)\fossil.bootstrap.js \ $(SRCDIR)\fossil.confirmer.js \ $(SRCDIR)\fossil.dom.js \ $(SRCDIR)\fossil.fetch.js \ $(SRCDIR)\fossil.page.fileedit.js \ $(SRCDIR)\fossil.tabs.js \ $(SRCDIR)\graph.js \ $(SRCDIR)\href.js \ $(SRCDIR)\login.js \ $(SRCDIR)\markdown.md \ $(SRCDIR)\menu.js \ $(SRCDIR)\sbsdiff.js \ | > | 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | $(SRCDIR)\diff.tcl \ $(SRCDIR)\forum.js \ $(SRCDIR)\fossil.bootstrap.js \ $(SRCDIR)\fossil.confirmer.js \ $(SRCDIR)\fossil.dom.js \ $(SRCDIR)\fossil.fetch.js \ $(SRCDIR)\fossil.page.fileedit.js \ $(SRCDIR)\fossil.storage.js \ $(SRCDIR)\fossil.tabs.js \ $(SRCDIR)\graph.js \ $(SRCDIR)\href.js \ $(SRCDIR)\login.js \ $(SRCDIR)\markdown.md \ $(SRCDIR)\menu.js \ $(SRCDIR)\sbsdiff.js \ |
︙ | ︙ |
Changes to www/fileedit-page.md.
︙ | ︙ | |||
73 74 75 76 77 78 79 | Similarly, some *potential* features have significant downsides, abuses, and/or implementation hurdles which make the decision of whether or not to implement them subject to notable contributor debate. e.g. the ability to add new files or remove/rename older files. | | > | > | > > > > > > > > | > > > > | > | 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 | Similarly, some *potential* features have significant downsides, abuses, and/or implementation hurdles which make the decision of whether or not to implement them subject to notable contributor debate. e.g. the ability to add new files or remove/rename older files. ### `/fileedit` **Stores Only Limited Local Edits While Working** When changes are made to a given checkin/file combination, `/fileedit` will, if possible, store them in `window.fileStorage` or `window.sessionStorage`, if available, but... - Which storage is used is unspecified and may differ across environments. - If neither of those is available, the storage is transient and will not survive a page reload. - It stores only the most recent last 7 checkin/file combinations which have been modified. Note that changing the "executable bit" is counted as a modification, but the checkin comment is not stored separately for each file. Exactly how long `fileStorage` will survive, and how much it can hold, is environment-dependent. `sessionStorage` will survive until the current browser tab is closed, but it survives across reloads of the same tab. If `/filepage` determines that no peristent storage is available ### The Power is Yours, but... > "With great power comes great responsibility." **Use this feature judiciously, *if at all*.** |
︙ | ︙ | |||
168 169 170 171 172 173 174 | ## Integrating a Custom Editor Widget *Hypothetically*, though this is currently unproven "in the wild," it is possible to replace `/filepage`'s basic text-editing widget (a `textarea` element) with a fancy 3rd-party editor widget by doing the following: | | | | 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | ## Integrating a Custom Editor Widget *Hypothetically*, though this is currently unproven "in the wild," it is possible to replace `/filepage`'s basic text-editing widget (a `textarea` element) with a fancy 3rd-party editor widget by doing the following: First, replace the `fossil.page.fileContent()` method with a custom implementation which can get and set the being-edited text from/to the custom editor widget: ``` fossil.page.fileContent = function(){ if(0===arguments.length){//call as a "getter" return the text-form content of your custom widget } else{// called as a setter set the content of your custom widget to arguments[0] and then: return this; // required by the interface! |
︙ | ︙ | |||
196 197 198 199 200 201 202 | fossil.page.replaceEditorWidget(yourNewWidgetElement); ``` That method must be passed a DOM element and may only be called once: it *removes itself* the first time it is called. That "should" be all there is to it. When `fossil.page` needs to get | | | | 211 212 213 214 215 216 217 218 219 220 | fossil.page.replaceEditorWidget(yourNewWidgetElement); ``` That method must be passed a DOM element and may only be called once: it *removes itself* the first time it is called. That "should" be all there is to it. When `fossil.page` needs to get the being-edited content, it will call `fossil.page.fileContent()` with no arguments, and when it sets the content (immediately after (re)loading a file), it will pass that content to `fossil.page.fileContent()`. |