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