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