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