Change RoleDetails.roles to be of type Set<Role>
[platform/upstream/folks.git] / NEWS
1 Overview of changes from libfolks 0.5.0 to libfolks 0.5.1
2 =========================================================
3
4 Bugs fixed:
5 * Bug 645388 — Group channels are leaked
6 * Bug 647562 — Don't crash on duplicate group channels
7 * Bug 647121 — Crash in individual_store_contact_sort at
8   empathy-individual-store.c line 1387
9 * Bug 645684 — Implement Iterator on LinkedHashSet
10
11 API changes:
12 * LinkedHashSet.list_iterator() is now disallowed (causes an assertion failure)
13 * LinkedHashSet.iterator() now returns a BidirIterator instead of just an
14   Iterator
15 * ImDetails.im_addresses is now of type MultiMap<string, string>
16 * WebServiceDetails.web_service_addresses is now of type
17   MultiMap<string, string>
18 * Removed LinkedHashSet in favour of Gee.HashSet
19 * Backend.persona_stores is now of type Map<string, PersonaStore>
20 * GroupDetails.groups is now of type Set<string>
21 * FieldDetails.parameters is now of type MultiMap<string, string>
22 * FieldDetails.get_parameter_values() now returns type Collection<string>
23 * FieldDetails.extend_parameters() now takes type MultiMap<string, string>
24 * PostalAddressDetails.postal_addresses is now of type Set<PostalAddress>
25 * EmailDetails.email_addresses is now of type Set<FieldDetails>
26 * PhoneDetails.phone_numbers is now of type Set<FieldDetails>
27 * UrlDetails.urls is now of type Set<FieldDetails>
28 * BackendStore.enabled_backends now has type Map<string, Backend>
29   - The corresponding C function folks_backend_store_dup_enabled_backends()
30     has been renamed folks_backend_store_get_enabled_backends(), and no longer
31     returns an owned variable.
32 * Individual.personas now has type Set<Persona>
33 * Individual.personas_changed now uses Set<Persona>-typed parameters
34 * PersonaStore.personas_changed now uses Set<Persona>-typed parameters
35 * IndividualAggregator.individuals_changed now uses
36   Set<Individual>-typed parameters
37 * IndividualAggregator.link_personas() now takes a Set<Persona>
38 * IndividualAggregator.get_all_potential_matches() now returns a
39   Map<Individual, Map<Individual, MatchResult>>
40 * IndividualAggregator.get_potential_matches() now returns a
41   Map<Individual, MatchResult>
42 * IndividualAggregator.individuals now has type Map<string, Individual>
43 * PersonaStore.personas now has type Map<string, Persona>
44 * LocalIdDetails.local_ids now has type Set<string>
45 * NoteDetails.notes now has type Set<Note>
46 * RoleDetails.roles now has type Set<Role>
47
48 Overview of changes from libfolks 0.4.0 to libfolks 0.5.0
49 =========================================================
50
51 Major changes:
52 * Add support to change primary (writeable) store either via
53   GConf or an env variable (bug 645441).
54 * Bumped Vala dependency to 0.12.0 for bug #646345
55
56 Bugs fixed:
57 * Bug 644968 - _update_phone_numbers() needs to create copies
58   of each List<FieldDetails>
59 * Bug 644966 - _update_emails () needs to create copies of each
60   List<FieldDetails>
61 * Bug 644527 - Add a Tracker backend
62 * Bug 645430 - folks-inspect: Use LinkedHashSet to access im-addresses
63 * Bug 645411 - folks-import segfaults on startup
64 * Crasher when removing Personas
65 * Crasher when reconnecting a Telepathy account
66 * Bug 645680 — Use random integer IDs for Kf.Personas
67 * Bug 645475 — Linker warnings for Tracker backend tests
68 * Bug 645570 — Fix checks for empty and equal StructuredNames
69 * Bug 645989 — Ensure add_persona_from_details handles the basic attribute
70 * Bug 645413 — Write support for Tracker
71 * Bug 645441 — Mechanism to specify primary backend
72 * Bug 638280 — Add a libsocialweb backend
73 * Deal with duplicated phones/e-mails in Tracker
74 * Bug 646944 — Fix libsocialweb updates and removals of contacts
75 * Bug 644867 — add interface for linkable web service contact UIDs
76 * Bug 647168 — print the "web-service-addresses" property correctly
77 * Bug 646831 — Setting an existing phone number or e-mail address on a
78   Trf.Persona fails
79 * Bug 647298 — folks-inspect gets SIGSEGV when trying to auto-complete
80   parameters
81 * Bug 646948 — Support for potential matches
82
83 API changes:
84 * Add equal () to StructuredName
85 * Add detail_key () along with an enum PersonaDetail to PersonaStore
86   which together define the basic attributes that should be supported
87   by add_persona_from_details ().
88 * Add public primary_store to IndividualAggregator
89 * Add LocalIdDetails interface for linking Personas based on local address book
90   IDs (such as for the Tracker backend Personas)
91 * Add WebServiceDetails interface for linking Personas based on web service
92   accounts (such as for the libsocialweb backend Personas)
93 * Add PotentialMatch class and IndividualAggregator.get_potential_matches() and
94   IndividualAggregator.get_all_potential_matches() to suggest Individuals that
95   may match the given Individual or all potential matches, respectively.
96
97 Overview of changes from libfolks 0.3.6 to libfolks 0.4.0
98 =========================================================
99
100 Bugs fixed:
101 * Bug 642351 — BACKEND_STORE_KEY_FILE format should support a wildcard entry
102 * Bug 643241 — _update_urls () needs to create copies of each
103   List<FieldDetails>
104 * Bug 643247 — Folks needs C API documentation
105 * Bug 643201 — folks-inspect can't handle properties which are
106   List<FieldDetails>
107 * Bug 642866 — tp-lowlevel leaks TpChannel
108 * Bug 642861 — FolksLinkedHashSet still alive when exiting Empathy
109 * Bug 642493 — Folks needs API for specifying a contact's organisation
110 * Bug 642500 — Folks needs API for specifying a contact's birthday
111 * Bug 642501 — Folks needs API for attaching notes to a Contact
112 * Bug 641210 — Add interface for postal addresses
113 * Bug 643956 — Use the correct signal name for postal addresses
114 * Bug 643954 — Add to_string () to PostalAddress class
115 * Bug 643955 — Add to_string () to RoleOwner class
116 * Bug 643957 — Deal handle birthday and postal-addresses.
117 * Bug 644457 — Handle structured names
118 * Bug 644165 — An individual's avatar shouldn't be replaced by a null avatar
119
120 API changes:
121 * Add RoleDetails interface
122 * Add BirthdayDetails interface
123 * Add NoteDetails interface
124 * Add PostalAddressDetails interface
125 * Rename Aliasable -> AliasDetails
126 * Rename AvatarOwner -> AvatarDetails
127 * Rename Emailable -> EmailDetails
128 * Rename Favouritable -> FavouriteDetails
129 * Rename GenderOwner -> GenderDetails
130 * Rename Groupable -> GroupDetails
131 * Rename IMable -> ImDetails
132 * Rename NameOwner -> NameDetails
133 * Rename Phoneable -> PhoneDetails
134 * Rename PresenceOwner -> PresenceDetails
135 * Rename Urlable -> UrlDetails
136
137 Overview of changes from libfolks 0.3.5 to libfolks 0.3.6
138 =========================================================
139
140 This is just a repackaging of libfolks 0.3.5 with some documentation comment
141 version numbers fixed.
142
143 Overview of changes from libfolks 0.3.4 to libfolks 0.3.5
144 =========================================================
145
146 Major changes:
147 * Various API breaks and improvements, especially in the IndividualAggregator
148 * Add various new interfaces: NameOwner, FieldDetails, Urlable, GenderOwner,
149   Phoneable and Emailable
150
151 API changes:
152 * Add NameOwner interface
153 * Add FieldDetails interface
154 * Add Urlable interface
155 * Add GenderOwner interface
156 * Add Phoneable interface
157 * Add Emailable interface
158 * Add Tpf.Persona.is_in_contact_list
159 * Rename the URLable interface to Urlable
160 * Take a PersonaStore in IndividualAggregator.add_persona_from_details
161 * Remove IndividualAggregatorError.STORE_NOT_FOUND
162 * Rename the getter for BackendStore.enabled_backends from
163   folks_backend_store_get_enabled_backends() to
164   folks_backend_store_dup_enabled_backends()
165 * Rename BackendStore.get_backend_by_name() to .dup_backend_by_name()
166
167 Bugs fixed:
168 * Bug 640901 — Allow it to be determined whether a user Tpf.Persona is in the
169   contact list
170 * Bug 641780 — Incorrect C function names for URLable interface
171 * Bug 629078 — Folks needs a full API review to take advantage of our
172   compatibility break in 0.2.x
173 * Bug 642036 — No way to pass a message when adding a contact
174
175 Overview of changes from libfolks 0.3.3 to libfolks 0.3.4
176 =========================================================
177
178 Major changes:
179 * Add folks-inspect tool
180 * The use of the new LinkedHashSet type in the API may make libgee a requirement
181   for some clients (to take full advantage of its class lineage).
182
183 API changes:
184 * New type: LinkedHashSet, similar to Gee.HashSet, but ordered.
185 * IMable.im_addresses is now a mapping of string to LinkedHashSet.
186 * Rename the HasAvatar interface to AvatarOwner
187 * Rename the HasPresence interface to PresenceOwner
188
189 Bugs fixed:
190 * Bug 637240 — libfolks-telepathy.so exports private symbols
191 * Bug 638311 — Add a HACKING file that outlines development policies and
192   coding style
193 * Bug 629083 — Review coding conventions in folks
194 * Bug 629075 — Add folks command line application
195 * Bug 638609 — libfolks hard-codes backend names for debugging
196 * Bug 639195 — Print stack traces for failed tests to improve remote
197   debugging
198 * Bug 639113 — Add static aggregation tests
199 * Bug 639742 — Logger service unavailable in make check
200 * Bug 640213 — Add tests for LinkedHashSet
201 * Bug 627397 — Use better interface names
202
203 Overview of changes from libfolks 0.3.2 to libfolks 0.3.3
204 =========================================================
205
206 Major changes:
207 * Fix some minor leaks
208 * Add support for building gtk-doc documentation for the C API
209 * Fix some related documentation problems
210 * Fix some Vala problems caused by differences between Vala 0.10 and 0.12
211 * Finish off renaming interfaces (this is an API break; see below)
212 * Don't trust personas from IRC
213 * Handle invalid IM addresses more gracefully than with an assertion failure
214 * Fix a linking problem with the user's individual when going offline which
215   could lead to infinite loops
216
217 API changes:
218 * Rename the Avatar interface to HasAvatar
219 * Rename the Presence interface to HasPresence
220 * Rename the Favourite interface to Favouritable
221 * Add IMableError
222 * Throw IMableError from IMable.normalise_im_address()
223
224 Bugs fixed:
225 * Bug 635178 — Leak in
226   folks_tp_lowlevel_connection_open_contact_list_channel_async
227 * Bug 635649 — autopoint fails to run
228 * Bug 635703 — Leak in connection_get_requestable_channel_classes_cb
229 * Bug 635823 — [PATCH] telepathy test not linking against GIO
230 * Bug 636251 — Fails to add contact
231 * Bug 629526 — Generate gtk-doc documentation
232 * Bug 627397 — Use better interface names
233 * Bug 636714 — Assertion failure on invalid IM address
234 * Bug 637136 — Infinite loop when disconnecting accounts
235
236 Overview of changes from libfolks 0.3.1 to libfolks 0.3.2
237 ==========================================================
238
239 Major changes:
240 * BackendStore.load_backends() now (un)loads backends which have been
241   (dis|en)abled since the last call
242 * FOLKS_BACKEND_DIR has been replaced by FOLKS_BACKEND_PATH. It accepts any
243   number of files and directories, separated by :
244 * Significantly clean up the build system
245
246 API changes:
247 * Added BackendStore.prepare() and BackendStore::is-prepared
248 * Add BackendStore.enable_backend().
249 * Add BackendStore.disable_backend().
250 * Add BackendStore.unprepare().
251 * Remove casting convenience methods on Individual (casting isn't hard)
252 * Change the visibility of the setters of PersonaStore.type_id,
253   PersonaStore.display_name, PersonaStore.id, Backend.name,
254   Backend.persona_stores and Persona.linkable_properties. This removes the
255   corresponding C setter methods which should never have been exposed
256 * Remove Tpf.PersonaError
257 * Remove the exception from the Tpf.Persona constructor
258
259 Bugs fixed:
260 * Bug 629081 — Add API to allow specific backends to be disabled
261 * Bug 629862 — Add tests for the key-file backend
262 * Bug 628883 — Add localisation support
263 * Bug 633718 — Make the Folks releases buildable without vala, valadoc, or
264   g-i
265 * Bug 633080 — Crash when disconnecting twice
266
267 Overview of changes from libfolks 0.3.0 to libfolks 0.3.1
268 ==========================================================
269
270 Major changes:
271 * Tpf.Persona.contact is now guaranteed to have the client type feature
272
273 API changes:
274 * Add the PersonaStore:can-add-personas property
275 * Add the PersonaStore:can-remove-personas property
276 * Add the PersonaStore:can-alias-personas property
277 * Add the PersonaStore:can-group-personas property
278 * Make Individual implement the IMable interface
279
280 Bugs fixed:
281 * Bug 630431 — notify::alias is never emitted
282 * Bug 631864 — Crash when empathy disconnects
283 * Bug 632096 — build failure: contact-retrieval.o: undefined reference to
284   symbol 'gee_abstract_collection_add'
285 * Bug 632163 — Folks key-file backend needs a way to point to a specific
286   .ini file
287 * Bug 632564 — assertion `EMPATHY_IS_CONTACT (contact)' failed in
288   individual_store_contact_sort
289
290 Overview of changes from libfolks 0.1.17 to libfolks 0.3.0
291 ==========================================================
292
293 Major changes:
294 * Fixed some linking problems
295 * Added some missing documentation
296 * Fixed build problems introduced by switching to gobject-introspection 0.9.6
297   (i.e. GIR format 1.2)
298 * Bumped telepathy-glib dependency to 0.11.16
299 * Bumped Vala dependency to 0.10.0
300 * Bumped gobject-introspection dependency to 0.9.6
301 * Ensured IM addresses are normalised before being compared
302 * Made the folks-import build optional through a configure argument
303 * Added support for a “self” individual
304 * Added support for generating and installing Devhelp format documentation
305 * BackendStore.load_backends and the prepare() functions are now idempotent
306 * Tpf.Persona.contact is now guaranteed to have the avatar token and data
307   features
308 * Tpf.Persona.contact is now guaranteed to have the capabilities feature
309
310 API changes:
311 * Added IMable.normalise_im_address()
312 * Renamed Groups interface to Groupable
313 * Renamed Alias interface to Aliasable
314 * Removed BackendStore constructor
315 * Added BackendStore.dup()
316 * Added BackendStore::enabled-backends
317 * Added Individual::is-user
318 * Added Persona::is-user
319 * Added IndividualAggregator::user
320 * Added PersonaStoreError.UNSUPPORTED_ON_USER
321 * Added {IndividualAggregator, PersonaStoreError}.STORE_OFFLINE, used by the
322   respective add_persona_from_details() functions
323
324 Bugs fixed:
325 * Bug 629452 — [Patch] Add missing gio linking for import-tool
326 * Bug 626008 — Add @since lines to all symbols
327 * Bug 629311 — Folks should normalize IDs written to the writable backend
328 * Bug 629644 — Key file backend cannot be loaded because of linking problems
329 * Bug 629666 — libfolks should not hard autodetect libxml
330 * Bug 628970 — Folks API needs a way to determine whether a specific type of
331   PersonaStore is available
332 * Bug 629096 — Add a library init function
333 * Bug 627402 — Support marking FolksPersonas as "me"
334 * Bug 629642 — individuals-changed emitted in the wrong order
335 * Bug 629643 — do not fall back to the id if alias is empty
336 * Bug 629006 — PersonaStore should gracefully handle offline Persona change
337   attempts
338 * Bug 629331 — BackendStore.load_backends and the prepare() functions should
339   be idempotent.
340 * Bug 629008 — Add a test for Persona additions
341 * Bug 630347 — Avatars are always NULL
342
343 Overview of changes from libfolks 0.1.16 to libfolks 0.1.17
344 ===========================================================
345
346 Major changes:
347 * Added a basic test suite
348 * Cleaned up the build system
349 * Ensured the public libraries' VAPI files are distributed and installed
350 * Prevented the key-file from being saved unnecessarily
351 * Fixed multi-byte character handling in the key-file backend
352 * Ensured account removal and invalidation is handled in the Telepathy backend
353 * Prevented a hang when creating relationships.ini in certain situations
354 * Added a folks-import tool to import meta-contact data from Pidgin; this adds
355   a dependency on libxml
356
357 API changes:
358 * Added PersonaStore.flush()
359
360 Bugs fixed:
361 * Bug 628930 — folks crahses empathy on relationships.ini read
362 * Bug 629082 — Empathy crashes when toggling "Ignore SSL certificate errors"
363   checkbox
364 * Bug 628853 — hangs if there's no relationships.ini file
365 * Bug 629084 — Add a folks-import tool
366
367 Overview of changes from libfolks 0.1.15 to libfolks 0.1.16
368 ===========================================================
369
370 Major changes:
371 * Added more debugging output
372 * Fixed various small outputted code bugs
373 * Fixed problem where key file groups would be overwritten in some situations
374 * Fixed various signal emission problems
375 * Prevented changes to Personas' properties from being propagated back up to the
376   Individuals
377 * Limited libgee dependency to < 0.7 due to API changes in libgee
378 * Added a FOLKS_DISABLE_LINKING environment variable to disable linking (for
379   debugging purposes)
380
381 Bugs fixed:
382 * Bug 628108 — Favorite contacts are not save any more
383 * Bug 628294 — Some contacts appear to be linked together while they shouldn't
384 * Bug 628305 — Signal removal of Individuals containing untrusted Personas
385 * Bug 628131 — error message when trying to link ICQ with jabber
386 * Bug 628343 — Add an environment variable to disable linking
387 * Bug 628335 — Assertion error with master
388
389 Overview of changes from libfolks 0.1.14.1 to libfolks 0.1.15
390 =============================================================
391
392 Major changes:
393 * Fixed various build problems
394 * Ensured duplicate entries don't appear in various sets
395 * Made gobject-introspection dependency explicit
396 * Limited libgee dependency to <= 0.5.2 due to API changes in libgee
397 * Reworked some of the Individual internals to make notifications more efficient
398 * Added the concept of an Individual's “trust level”
399 * Changed alias fallbacks to fall back to a display ID instead of a UID
400 * Added support for storing aliases in the key-file backend and use them in
401   preference to aliases from other Personas in an Individual
402
403 API changes:
404 * Added Individual:personas-changed
405 * Added TrustLevel enum
406 * Added Individual::trust-level
407 * Implemented Alias on Kf.Persona
408
409 Bugs fixed:
410 * Bug 627314 — folks cannot be install in gentoo sandbox
411 * Bug 627506 — Require gobject-introspection
412 * Bug 626725 — Add an Individual.personas_changed signal
413 * Bug 627968 — Add Individual.trust_level property
414 * Bug 626578 — Use vala's vala.m4 to check for telepathy-glib(.vapi)
415 * Bug 626410 — contacts show up with a weird alias
416 * Bug 627508 — Store alias and groups in the key-file backend
417 * Bug 627898 — Fails to install with -j4
418
419 Overview of changes from libfolks 0.1.14 to libfolks 0.1.14.1
420 =============================================================
421
422 Major changes:
423 * Bumped Vala dependency to 0.9.6
424 * Fixed some more warning spew
425
426 Overview of changes from libfolks 0.1.13 to libfolks 0.1.14
427 ===========================================================
428
429 Major changes:
430 * Changed Vala detection code to use the correct macro
431 * Bumped Vala dependency to 0.9.5
432 * Removed some more message spew
433 * Changed tp-lowlevel Vala bindings to be generated using gobject-introspection
434 * Added optional dependency on gobject-introspection 0.6.7
435
436 Overview of changes from libfolks 0.1.12 to libfolks 0.1.13
437 ===========================================================
438
439 Major changes:
440 * Added the concept of “linkable properties”
441 * Added the IMable interface
442 * Added the concept of persona store “trust”
443 * Added a writeable key-file backend
444 * Added linking support to the IndividualAggregator
445 * Tidied up ID handling in the backends
446 * Warn if a backend's MIME type could not be determined, notifying the user if
447   libfolks can't load backends due to shared-mime-info not being installed
448 * Hint to clients the Individual replacing a removed Individual (if any)
449 * Exposed Telepathy contacts' IM addresses using the IMable interface
450 * Fixed some build and dependency issues
451 * Bumped telepathy-glib dependency to 0.11.11 and dropped dependency on
452   telepathy-vala
453 * Added the concept of “writeable” PersonaStores and use this concept to prevent
454   properties being synchronised between PersonaStores unnecessarily (and
455   potentially even destructively)
456
457 API changes:
458 * Added Persona::linkable-properties
459 * Added IMable interface
460 * Added PersonaStoreTrust enum
461 * Added PersonaStore::trust-level
462 * Added Persona.LinkablePropertyCallback()
463 * Added Persona.linkable_property_to_links()
464 * Added Persona.build_uid()
465 * Added Persona.split_uid()
466 * Added Persona::display-id
467 * Added PersonaStore::display-name
468 * Added replacement_individual parameter to Individual:removed
469 * Implemented IMable on Tpf.Persona
470 * Added IndividualAggregatorError.NO_WRITEABLE_STORE
471 * Added IndividualAggregator.link_personas()
472 * Added IndividualAggregator.unlink_individual()
473 * Added PersonaStore::is-writeable
474
475 Bugs fixed:
476 * Bug 625830 — Adding an existing contact to the tp backend results in bogus
477   warnings
478 * Bug 626108 — Defining XDG_DATA_DIRS prevents backends from being loaded
479
480 Overview of changes from libfolks 0.1.11 to libfolks 0.1.12
481 ===========================================================
482
483 Major changes:
484 * Added debug flags support using the FOLKS_DEBUG environment variable
485 * Removed various bits of message and warning spew
486 * Bumped Vala dependency to 0.9.4
487 * Ensured connections which are ready as soon as they're connected are handled
488   correctly
489 * Versioned the installed backends using the main library's libtool version
490
491 Bugs fixed:
492 * Bug 625815 — No contat showed in the contact list
493
494 Overview of changes from libfolks 0.1.10 to libfolks 0.1.11
495 ===========================================================
496
497 Major changes:
498 * Moved various bits of preparation code out into async prepare() methods to
499   avoid race conditions on startup
500 * Reset TpfPersonaStore state when going offline
501 * Made several methods async which could potentially require it in future
502 * Added error throws to various functions which could potentially fail in future
503
504 API changes:
505 * Added PersonaStore.prepare()
506 * Added Backend.prepare()
507 * Removed error thrown from Backend constructor
508 * Added IndividualAggregator.prepare()
509 * Changed return type of Presence.is_online() from uint to int
510 * Made IndividualAggregator.remove_individual() async
511 * Made PersonaStore.remove_persona() async
512 * Added an error throw to BackendStore.load_backends()
513 * Added an error throw to IndividualAggregator.prepare()
514 * Added an error throw to IndividualAggregator.remove_individual()
515 * Added an error throw to IndividualAggregator.remove_persona()
516 * Added an error throw to PersonaStore.remove_persona()
517 * Made Groups.change_group() async
518 * Made Groups:group-changed async
519
520 Overview of changes from libfolks 0.1.9 to libfolks 0.1.10
521 ==========================================================
522
523 Major changes:
524 * Fixed various memory and reference leaks
525 * Lots of build system improvements
526 * Added a libtool version to the installed libraries
527
528 Initial release of libfolks 0.1.9
529 =================================
530
531 Major changes:
532 * Move to GNOME infrastructure