------------------------------------------------------------ revno: 348 committer: Siegfried-Angel Gevatter Pujals <[email protected]> branch nick: bluebird timestamp: Thu 2011-12-29 13:02:38 +0100 message: Add interpretation_for_mimetype and manifestation_for_uri functions, ported from libzeitgeist. This is needed to implement https://bugs.launchpad.net/zeitgeist/+bug/899602 added: src/mimetype.vala test/direct/mimetype-test.vala modified: .bzrignore src/Makefile.am test/direct/Makefile.am test/direct/assertions.vapi
-- lp:zeitgeist https://code.launchpad.net/~zeitgeist/zeitgeist/bluebird Your team Zeitgeist Framework Team is subscribed to branch lp:zeitgeist. To unsubscribe from this branch go to https://code.launchpad.net/~zeitgeist/zeitgeist/bluebird/+edit-subscription
=== modified file '.bzrignore' --- .bzrignore 2011-11-01 18:12:14 +0000 +++ .bzrignore 2011-12-29 12:02:38 +0000 @@ -54,3 +54,4 @@ extra/python/_ontology.py test/direct/*.c src/zeitgeist-daemon +mimetype-test === modified file 'src/Makefile.am' --- src/Makefile.am 2011-11-01 18:30:37 +0000 +++ src/Makefile.am 2011-12-29 12:02:38 +0000 @@ -44,6 +44,7 @@ where-clause.vala \ ontology.vala \ ontology-uris.vala \ + mimetype.vala \ $(NULL) zeitgeist_daemon_SOURCES = \ === added file 'src/mimetype.vala' --- src/mimetype.vala 1970-01-01 00:00:00 +0000 +++ src/mimetype.vala 2011-12-29 12:02:38 +0000 @@ -0,0 +1,343 @@ +/* datamodel.vala + * + * Copyright © 2011 Collabora Ltd. + * By Siegfried-Angel Gevatter Pujals <[email protected]> + * Copyright © 2010 Canonical, Ltd. + * By Mikkel Kamstrup Erlandsen <[email protected]> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 2.1 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +using Zeitgeist; + +namespace Zeitgeist +{ + + private static bool mimetypes_loaded = false; + private static bool schemes_loaded = false; + + private static HashTable<string, string>? mimetypes = null; + private static SList<MimeRegex?> mimetypes_regexs; + private static SList<UriScheme?> schemes; + + private struct MimeRegex + { + public Regex regex; + public string interpretation_uri; + + public MimeRegex (string mimetype_regex, string interpretation_uri) + throws RegexError + { + this.regex = new Regex (mimetype_regex, 0, 0); + this.interpretation_uri = interpretation_uri; + } + } + + private struct UriScheme + { + public string uri_scheme; + public string manifestation_uri; + } + + /** + * zeitgeist_register_mimetype: + * @mimetype: A MIME-type string. Eg. <emphasis>text/plain</emphasis> + * @interpretation_uri: A URI defining the subject interpretation type to + * associate with @mimetype + * + * Associate a MIME-type with a given interpretation type. Registered + * MIME-types can be looked up with zeitgeist_interpretation_for_mimetype(). + * + * You can register a regular expression as mimetype if instead of this + * function you invoke zeitgeist_register_mimetype_regex(). + * + * MIME-types are first looked up by their exact name and then if none is + * found the regular expressions will be checked as fallbacks. + * + * This library will install a wide range a common mimetypes for you, so + * unless you have very specific needs you will normally not have to call + * this function. + * + * FIXME: link to list of interpretations + */ + public void register_mimetype (string mimetype, string interpretation_uri) + { + if (mimetypes == null) + mimetypes = new HashTable<string, string>(str_hash, str_equal); + + mimetypes.insert (mimetype, interpretation_uri); + } + + /** + * zeitgeist_register_mimetype_regex: + * @mimetype: A regular expression matching a certain range of mimetypes. + * Eg. <emphasis>text/.*</emphasis> to match all + * <emphasis>text</emphasis> subtypes. + * @interpretation_uri: A URI defining the subject interpretation type to + * associate with the matched MIME-types + * + * Associate a range of MIME-types with a given interpretation type. + * Registered MIME-types can be looked up with + * zeitgeist_interpretation_for_mimetype(). + * + * If you only need to register one specific MIME-type, it is more efficient + * to use zeitgeist_register_mimetype() instead of this function. + * + * MIME-types are first looked up by their exact name and then if none is + * found the regular expressions will be checked as fallbacks. + * + * This library will install a wide range a common mimetypes for you, so + * unless you have very specific needs you will normally not have to call + * this function. + * + * FIXME: link to list of interpretations + */ + public void register_mimetype_regex (string mimetype_regex, + string interpretation_uri) throws RegexError + { + var entry = MimeRegex (mimetype_regex, interpretation_uri); + mimetypes_regexs.append (entry); + } + + /** + * zeitgeist_interpretation_for_mimetype: + * @mimetype: A MIME-type string. Eg. <emphasis>text/plain</emphasis> + * + * Look up the subject interpretation type associated with @mimetype. + * FIXME: link to list of interpretations + * + * Returns: A URI defining the subject interpretation type associated with + * @mimetype or %NULL in case @mimetype is unknown. + */ + public string? interpretation_for_mimetype (string mimetype) + { + ensure_mimetypes_loaded (); + + string? interpretation = mimetypes.lookup (mimetype); + if (interpretation != null) + return interpretation; + + foreach (unowned MimeRegex mime_regex in mimetypes_regexs) + { + if (mime_regex.regex.match (mimetype, 0)) + return mime_regex.interpretation_uri; + } + + return null; + } + + /** + * zeitgeist_register_uri_scheme: + * @uri_scheme: A URI scheme such as <emphasis>http://</emphasis> + * @manifestation_uri: A URI defining the subject manifestation type + * to associate with @uri_scheme + * + * Associate a URI scheme with a given subject manifestation type. + * You can find the manifestation type of a given URI by passing it to + * zeitgeist_manifestation_for_uri(). + * + * This library will install a range a common URI schemes for you, so unless + * you have very specific needs you will normally not have to call this + * function. + * + * FIXME: link to list of manifestations + */ + public void register_uri_scheme (string uri_scheme, + string manifestation_type) + { + UriScheme scheme = { uri_scheme, manifestation_type }; + schemes.append (scheme); + } + + /** + * zeitgeist_manifestation_for_uri: + * @uri: An URI + * + * Look up a subject manifestation type for a given URI. Eg. if you pass in + * <emphasis>file:///tmp/foo.txt</emphasis> you will get back + * #ZEITGEIST_NFO_FILE_DATA_OBJECT. + * + * FIXME: link to list of manifestations + * + * Returns: A subject manifestation type for @uri or %NULL in case no + * suitable manifestation type is known + */ + public string? manifestation_for_uri (string uri) { + ensure_schemes_loaded (); + + foreach (unowned UriScheme scheme in schemes) + { + if (uri.has_prefix (scheme.uri_scheme)) + return scheme.manifestation_uri; + } + + return null; + } + + private static void ensure_mimetypes_loaded () + { + if (mimetypes_loaded) + return; + + try { + register_mimetype ("text/x-patch", NFO.SOURCE_CODE); + register_mimetype ("application/postscript", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("image/png", NFO.RASTER_IMAGE); + register_mimetype ("application/x-m4", NFO.SOURCE_CODE); + register_mimetype ("application/x-deb", NFO.SOFTWARE); + register_mimetype ("text/x-tex", NFO.SOURCE_CODE); + register_mimetype ("application/x-shellscript", NFO.SOURCE_CODE); + register_mimetype ("text/x-ocaml", NFO.SOURCE_CODE); + register_mimetype ("application/x-gnumeric", NFO.SPREADSHEET); + register_mimetype ("application/x-executable", NFO.SOFTWARE); + register_mimetype ("application/rtf", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("application/x-fluid", NFO.SOURCE_CODE); + register_mimetype ("text/html", NFO.HTML_DOCUMENT); + register_mimetype ("text/x-python", NFO.SOURCE_CODE); + register_mimetype ("application/x-applix-spreadsheet", NFO.SPREADSHEET); + register_mimetype ("application/x-sql", NFO.SOURCE_CODE); + register_mimetype ("application/ogg", NFO.AUDIO); + register_mimetype ("application/x-perl", NFO.SOURCE_CODE); + register_mimetype ("application/x-bzip", NFO.ARCHIVE); + register_mimetype ("application/x-7z-compressed", NFO.ARCHIVE); + register_mimetype ("text/x-gettext-translation-template", NFO.SOURCE_CODE); + register_mimetype ("application/x-lzma", NFO.ARCHIVE); + register_mimetype ("application/ps", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("application/x-compressed-tar", NFO.ARCHIVE); + register_mimetype ("application/msexcel", NFO.SPREADSHEET); + register_mimetype ("application/xml", NFO.SOURCE_CODE); + register_mimetype ("text/x-lisp", NFO.SOURCE_CODE); + register_mimetype ("application/x-archive", NFO.ARCHIVE); + register_mimetype ("application/vnd.corel-draw", NFO.VECTOR_IMAGE); + register_mimetype ("text/x-troff", NFO.SOURCE_CODE); + register_mimetype ("application/ms-excel", NFO.SPREADSHEET); + register_mimetype ("text/x-c++", NFO.SOURCE_CODE); + register_mimetype ("text/plain", NFO.TEXT_DOCUMENT); + register_mimetype ("text/x-latex", NFO.SOURCE_CODE); + register_mimetype ("application/x-bzip-compressed-tar", NFO.ARCHIVE); + register_mimetype ("audio/x-scpls", NFO.MEDIA_LIST); + register_mimetype ("text/x-pascal", NFO.SOURCE_CODE); + register_mimetype ("application/x-cd-image", NFO.FILESYSTEM_IMAGE); + register_mimetype ("application/zip", NFO.ARCHIVE); + register_mimetype ("text/x-sql", NFO.SOURCE_CODE); + register_mimetype ("image/svg+xml", NFO.VECTOR_IMAGE); + register_mimetype ("application/x-ms-dos-executable", NFO.SOFTWARE); + register_mimetype ("application/x-lzma-compressed-tar", NFO.ARCHIVE); + register_mimetype ("application/ms-powerpoint", NFO.PRESENTATION); + register_mimetype ("text/x-eiffel", NFO.SOURCE_CODE); + register_mimetype ("application/x-java-archive", NFO.SOURCE_CODE); + register_mimetype ("application/pdf", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("text/x-csrc", NFO.SOURCE_CODE); + register_mimetype ("text/x-vala", NFO.SOURCE_CODE); + register_mimetype ("text/x-java", NFO.SOURCE_CODE); + register_mimetype ("text/x-gettext-translation", NFO.SOURCE_CODE); + register_mimetype ("application/x-killustrator", NFO.VECTOR_IMAGE); + register_mimetype ("text/x-credits", NFO.SOURCE_CODE); + register_mimetype ("application/x-glade", NFO.SOURCE_CODE); + register_mimetype ("application/x-php", NFO.SOURCE_CODE); + register_mimetype ("image/gif", NFO.RASTER_IMAGE); + register_mimetype ("application/javascript", NFO.SOURCE_CODE); + register_mimetype ("text/x-c++src", NFO.SOURCE_CODE); + register_mimetype ("image/tiff", NFO.RASTER_IMAGE); + register_mimetype ("text/x-makefile", NFO.SOURCE_CODE); + register_mimetype ("text/x-objcsrc", NFO.SOURCE_CODE); + register_mimetype ("text/x-idl", NFO.SOURCE_CODE); + register_mimetype ("application/x-applix-presents", NFO.PRESENTATION); + register_mimetype ("application/x-kpresenter", NFO.PRESENTATION); + register_mimetype ("application/x-rpm", NFO.SOFTWARE); + register_mimetype ("application/xhtml+xml", NFO.SOURCE_CODE); + register_mimetype ("text/x-chdr", NFO.SOURCE_CODE); + register_mimetype ("application/x-gzip", NFO.ARCHIVE); + register_mimetype ("application/x-dia-diagram", NFO.SOURCE_CODE); + register_mimetype ("application/x-csh", NFO.SOURCE_CODE); + register_mimetype ("text/css", NFO.SOURCE_CODE); + register_mimetype ("text/x-csharp", NFO.SOURCE_CODE); + register_mimetype ("image/jpeg", NFO.RASTER_IMAGE); + register_mimetype ("application/x-kspread", NFO.SPREADSHEET); + register_mimetype ("application/x-designer", NFO.SOURCE_CODE); + register_mimetype ("application/x-gnucash", NFO.SPREADSHEET); + register_mimetype ("image/x-xcf", NFO.RASTER_IMAGE); + register_mimetype ("text/x-lua", NFO.SOURCE_CODE); + register_mimetype ("application/x-desktop", NFO.SOFTWARE); + register_mimetype ("application/x-abiword", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("text/x-vhdl", NFO.SOURCE_CODE); + register_mimetype ("application/vnd.ms-excel", NFO.SPREADSHEET); + register_mimetype ("text/x-dsrc", NFO.SOURCE_CODE); + register_mimetype ("text/x-haskell", NFO.SOURCE_CODE); + register_mimetype ("application/x-object", NFO.SOURCE_CODE); + register_mimetype ("text/x-c", NFO.SOURCE_CODE); + register_mimetype ("application/x-ruby", NFO.SOURCE_CODE); + register_mimetype ("text/x-copying", NFO.SOURCE_CODE); + register_mimetype ("application/x-kword", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("application/x-applix-word", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype ("application/vnd.ms-powerpoint", NFO.PRESENTATION); + register_mimetype ("text/x-m4", NFO.SOURCE_CODE); + register_mimetype ("text/x-tcl", NFO.SOURCE_CODE); + register_mimetype ("application/ecmascript", NFO.SOURCE_CODE); + register_mimetype ("application/msword", NFO.PAGINATED_TEXT_DOCUMENT); + + register_mimetype_regex ( + "application/vnd.oasis.opendocument.text.*", + NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype_regex ( + "application/vnd.oasis.opendocument.presentation.*", + NFO.PRESENTATION); + register_mimetype_regex ( + "application/vnd.oasis.opendocument.spreadsheet.*", + NFO.SPREADSHEET); + register_mimetype_regex ( + "application/vnd.oasis.opendocument.graphics.*", + NFO.VECTOR_IMAGE); + register_mimetype_regex ("application/vnd\\..*", NFO.DOCUMENT); + register_mimetype_regex ("application/x-applix-.*", NFO.DOCUMENT); + register_mimetype_regex ( + "application/vnd.ms-excel.*", + NFO.SPREADSHEET); + register_mimetype_regex ( + "application/vnd.ms-powerpoint.*", + NFO.PRESENTATION); + register_mimetype_regex (".*/x-dvi", NFO.PAGINATED_TEXT_DOCUMENT); + register_mimetype_regex ("image/.*", NFO.IMAGE); + register_mimetype_regex ("audio/.*", NFO.AUDIO); + register_mimetype_regex ("video/.*", NFO.VIDEO); + } catch (RegexError e) { + // This won't happen. + assert (false); + } + + mimetypes_loaded = true; + } + + private static void ensure_schemes_loaded () + { + if (schemes_loaded) + return; + + register_uri_scheme ("file://", NFO.FILE_DATA_OBJECT); + register_uri_scheme ("http://";, NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("https://";, NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("ssh://", NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("sftp://";, NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("ftp://";, NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("dav://", NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("davs://", NFO.REMOTE_DATA_OBJECT); + register_uri_scheme ("smb://", NFO.REMOTE_DATA_OBJECT); + + schemes_loaded = true; + } + +} + +// vim:expandtab:ts=4:sw=4 === modified file 'test/direct/Makefile.am' --- test/direct/Makefile.am 2011-10-12 21:13:12 +0000 +++ test/direct/Makefile.am 2011-12-29 12:02:38 +0000 @@ -13,6 +13,7 @@ query-operators-test \ where-clause-test \ table-lookup-test \ + mimetype-test \ $(NULL) SRC_FILES = \ @@ -31,6 +32,7 @@ $(top_srcdir)/src/sql.vala \ $(top_srcdir)/src/ontology.vala \ $(top_srcdir)/src/ontology-uris.vala \ + $(top_srcdir)/src/mimetype.vala \ $(NULL) marshalling: marshalling.vala $(SRC_FILES) @@ -45,6 +47,9 @@ table-lookup-test: table-lookup-test.vala $(SRC_FILES) $(VALAC) $(VALAFLAGS) -o $@ $^ +mimetype-test: mimetype-test.vala $(SRC_FILES) + $(VALAC) $(VALAFLAGS) -o $@ $^ + clean-local: rm -f *.~[0-9]~ @@ -53,6 +58,7 @@ query-operators-test \ where-clause-test \ table-lookup-test \ + mimetype-test \ $(NULL) EXTRA_DIST = \ @@ -60,6 +66,7 @@ query-operators-test.vala \ where-clause-test.vala \ table-lookup-test.vala \ + mimetype-test.vala \ assertions.vapi \ $(NULL) === modified file 'test/direct/assertions.vapi' --- test/direct/assertions.vapi 2011-08-12 15:00:59 +0000 +++ test/direct/assertions.vapi 2011-12-29 12:02:38 +0000 @@ -14,7 +14,7 @@ [CCode (cname = ">=")] GREATER_OR_EQUAL } - + public void assert_cmpstr (string? s1, OperatorType op, string? s2); public void assert_cmpint (int n1, OperatorType op, int n2); public void assert_cmpuint (uint n1, OperatorType op, uint n2); === added file 'test/direct/mimetype-test.vala' --- test/direct/mimetype-test.vala 1970-01-01 00:00:00 +0000 +++ test/direct/mimetype-test.vala 2011-12-29 12:02:38 +0000 @@ -0,0 +1,108 @@ +/* where-clause-test.vala + * + * Copyright © 2011 Collabora Ltd. + * By Siegfried-Angel Gevatter Pujals <[email protected]> + * Copyright © 2010 Canonical, Ltd. + * By Mikkel Kamstrup Erlandsen <[email protected]> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 2.1 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +using Zeitgeist; +using Assertions; + +void main (string[] args) +{ + Test.init (ref args); + + Test.add_func ("/MimeType/basic", mime_type_basic_test); + Test.add_func ("/MimeType/regex", mime_type_regex_test); + Test.add_func ("/MimeType/none", mime_type_none_test); + Test.add_func ("/MimeType/register", mime_type_registration_test); + + Test.add_func ("/UriScheme/basic", uri_scheme_basic_test); + Test.add_func ("/UriScheme/none", uri_scheme_none_test); + Test.add_func ("/UriScheme/register", uri_scheme_registration_test); + + Test.run (); +} + +public void mime_type_basic_test () +{ + assert_cmpstr (NFO.TEXT_DOCUMENT, OperatorType.EQUAL, + interpretation_for_mimetype ("text/plain")); +} + +public void mime_type_regex_test () +{ + // We should have a fallack for application/x-applix-* + assert_cmpstr (NFO.DOCUMENT, OperatorType.EQUAL, + interpretation_for_mimetype ("application/x-applix-FOOBAR")); + + // Still application/x-applix-speadsheet should be a spreadsheet + assert_cmpstr (NFO.SPREADSHEET, OperatorType.EQUAL, + interpretation_for_mimetype ("application/x-applix-spreadsheet")); +} + +public void mime_type_none_test () +{ + assert (interpretation_for_mimetype ("foo/bar") == null); +} + +public void mime_type_registration_test () +{ + register_mimetype ("awesome/bird", "Bluebird"); + try + { + register_mimetype_regex ("everything/.*", "is nothing"); + } catch (RegexError e) { + assert (false); + } + + mime_type_basic_test (); + mime_type_regex_test (); + mime_type_none_test (); + + assert_cmpstr ("Bluebird", OperatorType.EQUAL, + interpretation_for_mimetype ("awesome/bird")); + assert_cmpstr ("is nothing", OperatorType.EQUAL, + interpretation_for_mimetype ("everything/everywhere")); +} + +public void uri_scheme_basic_test () +{ + assert_cmpstr (NFO.FILE_DATA_OBJECT, OperatorType.EQUAL, + manifestation_for_uri ("file:///tmp/foo.txt")); + assert_cmpstr (NFO.REMOTE_DATA_OBJECT, OperatorType.EQUAL, + manifestation_for_uri ("ftp://ftp.example.com";)); +} + +public void uri_scheme_none_test () +{ + assert (manifestation_for_uri ("asdf://awesomehttp://";) == null); +} + +public void uri_scheme_registration_test () +{ + register_uri_scheme ("42://", "the answer"); + + uri_scheme_basic_test (); + uri_scheme_none_test (); + + assert_cmpstr ("the answer", OperatorType.EQUAL, + manifestation_for_uri ("42://what is it?")); +} + +// vim:expandtab:ts=4:sw=4
_______________________________________________ Mailing list: https://launchpad.net/~zeitgeist Post to : [email protected] Unsubscribe : https://launchpad.net/~zeitgeist More help : https://help.launchpad.net/ListHelp
