Add defun to make the start page
[elpher.git] / ISSUES.org
1 #+TITLE: Development notes/ideas
2 #+TODO: OPEN(o!) | CLOSED(c!) INVALID(i@)
3 #+STARTUP: logdrawer
4    
5 * Open Bugs
6
7 * Closed Bugs
8   
9 ** CLOSED Org mode faces are not present in recent emacs versions
10 Even 26.1 doesn't seem to have these.  This means that, for many
11 users, elpher doesn't show any difference between any of the
12 item types.  Not a major problem at all, but the faces we inherit
13 from should definitely be ones which have been present for much
14 longer.  Perhaps the font lock mode faces are the way to go after
15 all.
16
17 Update: changed all default faces to inherit from font-lock and basic faces.
18
19 ** CLOSED URL-centric addressing breaks bookmark file compatibility
20    
21 Need a way to allow people to rescue their old bookmark files
22 following this update.
23
24 ** CLOSED History loops <2019-11-08 Fri>
25
26 Occasionally elpher gets stuck in a "history loop" where a
27 node is its own grandparent.  Obviously this sucks, as history
28 is elpher's main mechanism for making gopherspace exploration
29 painless.
30
31 I suspect the problem is in either ~elpher-visit-node~ or
32 ~elpher-visit-parent~.
33
34 Follow-up: this has been fixed by the new stack-based history system
35 in 2.5.
36
37
38 ** CLOSED Redirects do not rewrite current address
39
40 This is a bug, as gemini://blah.com/hi may get redirected
41 to gemini://blah.com/hi/, at which point link lines
42 of the form "=> there" should be interpreted as pointing
43 at gemini://blah.com/hi/there, while currently they are
44 interpreted as pointing at gemini://blah.com/there.
45
46 ** CLOSED History inconsistency when restarting elpher <2020-05-26 Tue>
47
48 To reproduce:
49 1. open elpher and follow a few links until you're a handful of links below
50    the start page.
51 2. kill the elpher buffer with C-x k
52 3. Open elpher again, which will show the start page.
53 4. Press 'u' to go up.  Elpher wiill respond stating that there is no previous page.
54 5. Press 'u' again. Elpher will then jump to the page that was open when
55    the buffer was originally killed.
56
57 Expected behaviour: elpher should be once again at the bottom of the history
58 stack and should not remember the previous history.
59
60 Observed behaviour: elpher _does_ remember the previous history.
61
62 *** update <2020-05-27 Wed>
63 Turns out this was just because the `elpher` function was merely setting
64 the `elpher-current-page` variable to nil, then using `elpher-visit-page`
65 to visit the start page, resulting in the nil being pushed onto the existing
66 history stack.  Because `elpher-visit-previous-page` always trys to pop from
67 this stack and tests whether the result is nil (which it is when the stack is empty),
68 the first "u" would result in the "no previous page" message but would still
69 pop the stack, meaning that subsequent "u" commands would succeed.
70
71 The fix is just to zero out the history list in the `elpher` function just as
72 `elpher-current-page` is cleared.
73
74 * Open Enhancements
75
76 ** OPEN Allow multiple elpher buffers [33%]
77
78    Shouldn't be too hard, just need elpher-current-node to be
79 buffer-local and allow various buffer-switching procedures to
80 do something sensible.
81
82 Here are the things that need to be implemented before
83 this can happen:
84 - [X] shift history out of node tree and into separate stack
85 - [ ] make history stack variables buffer-local
86 - [ ] have elpher-with-clean-buffer select appropriate buffer 
87
88 ** OPEN Replace support for user-specified starting pages
89 This used to be available, but was removed during a refactor.
90
91 ** OPEN Allow for grouping of bookmarks
92 To support this I'd like to add a bookmark page specific
93 set of keybindings.  Currently all bindings available on
94 the bookmark page are available everywhere else.  But
95 expanding and collapsing bookmark groups sounds like it
96 might need more specific bindings.
97
98 *** Priority bump <2020-05-31 Sun>
99
100 As bookmark lists grow, some sort of grouping is becoming more and more
101 important.  Furthermore, with this in place it would become feasible
102 (and I really suspect almost trivial) to implement an update-checking
103 system for chosen groups of bookmarks.
104
105 For instance, we could prefetch content for each of the addresses within
106 a chosen group, indicating which had been changed since the last fetch.
107 (We could just store hashes of earlier content to detect changes.)
108
109 The difficult thing to decide is how the UI for the new bookmark page
110 will work.  It already has its own renderer, and we could easily stop
111 using the gopher directory line renderer in favour of something more
112 amenable to displaying the group information.  Thus we're very free to
113 do whatever we like once we also have a special key map in place as well.
114
115 I guess I need to look into what native widgets Emacs has for displaying
116 collapsable hierarchies.
117
118 ** OPEN Add history browsing
119    
120 ** OPEN Sanitize certificate names
121    :LOGBOOK:
122    - State "OPEN"       from              [2020-06-22 Mon 10:32]
123    :END:
124    
125 Currently things will break in undefined ways if a name is specified
126 that contains path separators and probably other characters that I
127 haven't thought of.  This is dangerously unacceptable and needs to be
128 fixed right away.
129
130 ** OPEN Make installing existing certificates easier
131    :LOGBOOK:
132    - State "OPEN"       from "CLOSED"     [2020-06-22 Mon 10:34]
133    :END:
134
135 It's naive to think that people don't have client certificates created
136 outside of elpher. Thus we need some easy way to "install" these
137 certificates, either by copying them or by referencing them in some
138 way.
139
140 * Closed Enhancements
141   
142 ** CLOSED Turn on lexical scoping
143
144    A branch exists for this, but there are some compilation kinks
145 to iron out.
146
147   
148 ** CLOSED Implement support for telnet entries
149
150 Similar to http entries, telnet entries will be handled by code
151 external to elpher. However it seems I made http entry handling a
152 special case, and I don't want another!  So the only option is to
153 bring both http and telnet entries back into the fold by representing
154 them both as standard nodes and having the grunt work done by getter
155 functions.
156
157 ** CLOSED Allow users to access selected and current node details.
158    
159 ** CLOSED Implement bookmark system
160
161   Currently the bookmark page replaces the current page, and it
162   does so silently (i.e. it doesn't become part of the link hierarchy).
163   I think this is a mistake, as it results in confusing behaviour when
164   traversing the link hierarchy after visiting one of the bookmarked links.
165
166   Instead, I think I should
167   1. Make the bookmark page part of the hierarchy, and
168   2. Reinstate the visited node hash table to avoid excess link hierarchy pollution.
169
170   In order to accomplish 1. it will be necessary to make the bookmark page renderer
171   a proper getter function, and one that never caches the contents of the buffer.
172
173   Actually, I might have to think about that a bit more.  I don't know
174   how to answer the question of what the best thing to do with node
175   parent links when using a cached node in place of a new node.  (Maybe
176   I always update node.parent unless parent is already an ancestor of
177   node?)
178
179   
180 ** CLOSED Support character encoding diversity
181
182 ** CLOSED Make URLs the basic address type.
183 Currently I waste a lot of effort converting between
184 URL and non-URL representations.  This is unnecessary, and
185 actually makes lots of things uglier.
186
187 For example, the bookmarks file contains addresses in Elpher's
188 internal representation, whereas I expect users would prefer
189 it contain URLs.
190
191 So the idea would be for (elpher-node-address node) to be
192 a either a string or a symbol, with symbols used for "special"
193 pages (bookmarks, start page, etc).  The getter functions
194 `elpher-address-selector' etc will still do what they currently
195 do, but will process the URL to do it.
196
197 This also means that non-gopher URLs will be explicitly represented
198 as such: no more abusing the "h" type for these.
199
200 ** INVALID Remove "redraw" command
201 This is only necessary for returning from displaying the raw
202 server response.  If I can provide a better way of doing that
203 then we can get rid of redraw entirely.
204
205 Actually, this command can be useful to correct rendering issues that
206 occasionally pop up in termal windows.  Lets leave it for now.
207
208 ** CLOSED Implement Finger support
209    
210 ** CLOSED Improve download performance
211    This is actually easy to fix - the major problem at the moment is
212    the braindead way the incrementally-retrieved data is recorded:
213    (setq result-string (concat result-string next-bit)).
214    This is O(N^2).  Yuck!
215    
216    Okay, replacing this really does improve things.  Large gemini
217    downloads now seem occur at rates I'd expect.
218    
219 ** CLOSED Download/rendering progress feedback
220    Particularly for large files or complicated pages, elpher can
221    take a few seconds or more to generate a response.  Thhis is
222    frustrating for users, who are left staring at a blinking
223    cursor.
224
225    A small amount of feedback could help with this.
226
227 ** CLOSED Implement Gemini support [100%]
228    :LOGBOOK:
229    - State "CLOSED"     from "OPEN"       [2020-06-20 Sat 22:32]
230    :END:
231    
232 Here is the checklist of features required before release:
233 - [X] basic genimi transactions
234 - [X] gemini transactions requiring client certificates
235 - [X] gemini input handling
236 - [X] gemini map files (text/gemini)
237 - [X] Support for plain text responses (text/*)
238 - [X] Support for image responses (text/image)
239 - [X] Support for mime-specified character encodeing
240 - [X] Saving responses to disk
241 - [X] Viewing raw responses
242   
243 The last few will be made infinitely easier if we factor the
244 gopher "getter" code differently.