chiark / gitweb /
First cut at cookie support in the web interface
[disorder] / CHANGES
1 See ChangeLog.d/* for detailed revision history.
2
3 * Changes up to version 2.1
4
5 ** Server
6
7 Users are now stored in the database rather than a configuration file.
8
9 * Changes up to version 2.0
10
11 ** General
12
13 Tracks can now have tags associated with them.  See tags in disorder(1)
14 or the preferences documentation for the web interface or Disobedience.
15
16 The search facility knows how to limit results by tag (see search
17 documentation for any interface) as well as by word search.  It is
18 possible to limit random play by tag (see required-tags and
19 prohibited-tags in disorder_config(5)).
20
21 Unicode support is improved.  Case-folding and word breaking now follows
22 the rules given in the Unicode standard (with a bit of tailoring in the
23 latte case).
24
25 ** Disobedience
26
27 There is a new client, 'Disobedience', that depends on the GTK+ library.
28 Feedback on the interface would be very welcome.
29
30 ** Web Interface
31
32 The "New" screen display tracks recently added to the database.  From
33 here they can be played or their preferences changed.
34
35 Long track names are truncated so they fit better on the screen.  Hover
36 for the full name.
37
38 ** Network Play
39
40 DisOrder can broadcast audio over a network, allowing it to be played on
41 multiple client machines.  See README.streams for details.
42
43 ** Server
44
45 Slow file lookups are cached in the server.  This should help
46 installations with large collections and/or slow platforms.
47
48 The 'enabled' and 'random_enabled' configuration options are now gone.
49 Instead the state survives from one run of the server to the next.
50 'disable now' is gone as well - if you want to emulate it disable
51 playing and then scratch the current track.
52
53 The 'pick' plugin has been abolished.  All the logic formerly done there
54 is now built into the server, where it can be done much more
55 efficiently.
56
57 'tracklength' plugins must be explicitly specified.
58
59 A bug where removing a collection (from the configuration) could cause a
60 crash when random play was enabled has been fixed.
61
62 A new configuration option 'queue_pad' allows the number of random
63 tracks kept on the queue to be controlled.
64
65 There is a new utility disorder-decode which can decode OGG, MP3, WAV
66 and FLAC.  The example config file uses it.
67
68 Database statistics are computed in a subprocess so that the main server
69 (and all clients) are not blocked for the duration.
70
71 ** disorderfm
72
73 There is a new command line tool called 'disorderfm' which is designed
74 for filename translation on (for instance) digital audio repositories.
75 It is not yet feature-complete.  See its man page for additional
76 details.
77
78 ** Build And Configuration
79
80 You can control which components are built with new --with options.  See
81 README.
82
83 options.transform and the 'transform' web option have gone, replaced
84 with a 'transform' configuration command.  Both this and 'namepart' are
85 now optional.
86
87 ** Thanks
88
89 Ross Younger, Colin Watson, Michael Stevens and Mark Wooding all
90 contributed in some way to this release.
91
92 * Changes up to version 1.5.1
93
94 ** Web Interface
95
96 Correct regexp for non-alpha tracks.
97
98 * Changes up to version 1.5
99
100 ** Web Interface
101
102 Regexp-based filtering of tracks (for instance as used by the initial
103 'Choose' page) now does the regexp matching in the server, limiting the
104 amount of data transferred to the web interface only to be discarded.
105
106 ** Client
107
108 Regexp-base filtering of tracks is now available to the command line
109 client.
110
111 ** Server
112
113 New server_nice, speaker_nice and rescan_nice configuration options
114 allow independent control of process priorities.
115
116 Scratches are now attributed to the user who requested them.
117
118 Bugs fixed:
119   A file descriptor was leaked for each track played.
120   The amount of a track played so far was not reported.
121   The speaker process could crash on underrun.
122   The server would crash if you paused a non-pause capable track.
123   Regexp matching in the file and directory list commands was not
124   reliable.
125   Handling of variable-argument commands in the client was broken.
126
127 * Changes up to version 1.4
128
129 ** General
130
131 Raw format players are now supported.  See README.upgrades and
132 README.raw for details.  This allows pausing and eliminating the
133 inter-track gap.
134
135 Pausing is also supported with suitably modified standalone player
136 plugins, though none of the supplied ones are capable of this.
137
138 When random play is enabled the randomly picked track now appears in the
139 queue, and can be moved around the queue, removed from it, etc.
140
141 ** Web Interface
142
143 Switches (random play, pause, ...) are now presented as a
144 fixed-appearance switch with an adjacent state indicator.
145
146 The 'Manage' screen has new buttons to move tracks to the head or tail
147 of the queue.
148
149 You can now edit the preferences for all the tracks in an album in a
150 single screen, rather than having to visit each separately.  For the
151 time being the raw preferences editing has gone; it can be reintroduced
152 on some form if there is demand.  (You can still edit raw preferences
153 from the command line.)
154
155 Labels are now documented in options.labels rather than
156 disorder_config(5).
157
158 ** Server
159
160 If you tried to start up on any empty database with random play enabled
161 the server would exit with an error.
162
163 The server no longer risks failing if you strace its player
164 subprocesses.
165
166 It was possible for the server to hang when a 'reconfigure' command was
167 issued.  This should no longer be the case.
168
169 The default signal to forcibly terminate players is now SIGKILL.
170
171 ** Plugins
172
173 Plugins must now declare a type word.  This allows them to document
174 whether they are a standalone player or a raw-format player, and whether
175 they support pausing.  They can also arrange to get setup and cleanup
176 calls in the main server.  See disorder(3) for more details.
177
178 * Changes up to version 1.3
179
180 ** Dependencies
181
182 Berkeley DB 4.2 is no longer supported.  Use 4.3.
183
184 ** Client
185
186 There is a new 'authorize' command to simplify the addition of local
187 users.  Please report successes as well as failures.
188
189 There is a new 'resolve' command to return the real track name behind an
190 alias.
191
192 The 'rescan' command no longer takes an argument.
193
194 ** Server
195
196 The track database code has been largely rewritten to improve
197 maintainability.
198
199 There is a new 'lock' directive.  By default the server uses a lockfile
200 to prevent multiple copies of itself running simultaneously; this can be
201 inhibited e.g. if you are using a filesystem that does not support
202 locking and are confident you can prevent concurrent running yourself.
203
204 Aliases for track names, constructed from trackname_display_
205 preferences, now appear in the virtual filesystem.  
206
207 The server now executes a subprocess for the rescan operation.  It also
208 runs a separate deadlock manager.
209
210 Standard output and standard error from subprocesses are now logged.
211 This is handy if you need to figure out why a player failed unexpectedly
212 but might lead to huge log files if you have needlessly verbose players.
213
214 ** Web Interface
215
216 Enable/disable buttons are now colored to reflect current state.
217
218 Entering numeric volume values (rather than clicking on the arrows) now
219 works.
220
221 Connection errors are reported more gracefuly.
222
223 ** Plugins
224
225 Scanner plugins are now always invoked in a subprocess.
226
227 disorder_track_count() and disorder_track_getn() are no longer
228 available.  Instead use disorder_track_random().
229
230 Plugins are now opened with RTLD_NOW, so link errors are detected
231 immediately.
232
233 ** Tools
234
235 disorder-dump now insists on the input/output file being a named regular
236 file, rather than using stdin or stdout.
237
238 ** Other
239
240 Some missing files have been added, and some notes added regarding
241 getting text encoding right.
242
243 * Changes up to version 1.2
244
245 See README.upgrades when upgrading to this version.
246
247 ** Bugs Fixed
248
249 Avoid accumulating overlarge recently played list.
250
251 When the server was stopped, the currently playing track would not be
252 added to the recently played list.  This has been fixed.
253
254 Reloading the 'volume' page no longer repeats the last volume-changing
255 action.
256
257 The search facility now works properly for multiple hits within a single
258 artist or album.
259
260 ** Server
261
262 New namepart directive replaces web interface's trackname-part.  There
263 are associated changes to the protocol and clients.
264
265 The number of database queries per candidate match required when
266 searching has been reduced.
267
268 The operator can control the signal used to scratch playing tracks.  The
269 default has been changed to SIGINT from SIGKILL.
270
271 The 'log' command now provides a formalised event log, rather than raw
272 access to the server's ordinary log output.
273
274 ** Web Interface Changes
275
276 *** Choosing Tracks
277
278 When picking a track the client now stays on the same screen rather than
279 redirecting back to the 'Playing' screen.  So that the user gets
280 feedback from their action, playing and queued tracks are now marked as
281 such in the track picking screen.
282
283 It is possible to revert to the old behaviour by removing the back=
284 argument from the choose.html and search.html templates (and optionally
285 the trackstate lines).
286
287 *** Search
288
289 Non-ASCII characters are now properly supported in search terms.
290
291 *** Syntax
292
293 The template syntax has been changed slightly to ignore whitespace in
294 certain places.
295
296 *** Miscellaneous
297
298 Some formerly textual buttons are now replaced by images (with ALT text
299 reflecting the old value).  The stylesheet is now a .css file (installed
300 in the same place as the images) rather than being embedded into every
301 template.
302
303 Artist and album names in the playing and recently-played lists are now
304 links to the corresponding directory.
305
306 More functions are now available from the 'manage' screen.
307
308 The menus are now (by default) across the top of the screen instead of
309 down the side.  Set the 'menu' label to 'sidebar' to restore the old
310 appearance.  'Volume' is not present in this new menu, use 'Manage'
311 instead (or edit the template).
312
313 ** tkdisorder
314
315 tkdisorder now displays artist, album and title in the queue and
316 recently played widgets, rather than just the title (as formerly).
317
318 * Changes up to version 1.1
319
320 ** Bugs Fixed
321
322 Corrected various problems with UTF-8 parsing.
323
324 In the web interface, "The Beatles" (etc) are now grouped under 'B' not
325 'T' when grouping tracks by initial letter.
326
327 ** Server
328
329 The list of recently played tracks is now preserved across server
330 restarts.
331
332 Track IDs are more compact.
333
334 Versions of libdb before 4.2 are no longer supported.  4.2 and 4.3 both
335 work now.  4.2 support will be removed in some future release.
336
337 Prehistoric backwards-compatibility logic removed.  Only affects people
338 upgrading from long before 1.0 (who should upgrade to 1.0 and then to
339 1.1.)
340
341 ** Command Line
342
343 Tracks can be moved in the queue from the command line.
344
345 'disorder queue' now reports track IDs.
346
347 $pkgdatadir/completion.bash provides tab completion over commands and
348 options.
349
350 ** Web Interface
351
352 New 'cooked' preferences interface saves users having to know arcane
353 details of trackname preferences and so on.  Non-ASCII characters are
354 now properly supported in this context.
355
356 CGI arguments to the web interface are now checked for UTF-8 compliance.
357
358 Local Variables:
359 mode:outline
360 fill-column:72
361 End: