pax_global_header00006660000000000000000000000064146016012150014506gustar00rootroot0000000000000052 comment=b4d7e4690fc2c91832d4ac56371e3da4f1570db9 ocaml-lastfm-0.3.4/000077500000000000000000000000001460160121500140715ustar00rootroot00000000000000ocaml-lastfm-0.3.4/.github/000077500000000000000000000000001460160121500154315ustar00rootroot00000000000000ocaml-lastfm-0.3.4/.github/workflows/000077500000000000000000000000001460160121500174665ustar00rootroot00000000000000ocaml-lastfm-0.3.4/.github/workflows/ci.yml000066400000000000000000000005351460160121500206070ustar00rootroot00000000000000name: CI on: [push] concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: [macos-latest, ubuntu-latest] steps: - name: Build and test module uses: savonet/build-and-test-ocaml-module@main ocaml-lastfm-0.3.4/.gitignore000066400000000000000000000000711460160121500160570ustar00rootroot00000000000000*~ _build *.byte *.native _tests .merlin *.install *.sw* ocaml-lastfm-0.3.4/.ocamlformat000066400000000000000000000003371460160121500164010ustar00rootroot00000000000000version=0.25.1 profile = conventional break-separators = after space-around-lists = false doc-comments = before match-indent = 2 match-indent-nested = always parens-ite exp-grouping = preserve module-item-spacing = compact ocaml-lastfm-0.3.4/CHANGES000066400000000000000000000034011460160121500150620ustar00rootroot000000000000000.3.4 (03-27-2024) ===== * Switched to Re 0.3.3 (03-01-2021) ===== * Switched to dune! 0.3.2 (18-08-2018) ===== * Fix compilation with OCaml >= 4.06 0.3.1 (03-08-2015) ===== * Switch to Bytes API. 0.3.0 (13-05-2011) ===== * Added timeout for http operations (#351) * Fixed bug when submitting to two different hosts with the same user and password. * Functorized Audioscrobbler and Radio to allow to build a version without using ocamlnet.. 0.2.0 (12-10-2009) ===== * Added support for --enable-debugging configure option * Fixed Makefile for BSD: call $(MAKE) for generating documentation. * Now using xmlm instead of xml-light. * Removed anonymous radio connection: no longer available upstream... :-( * Made audioscrobbler host configurable, in order to allow libre.fm or other implementations. 0.1.3 (17-09-2008) ==== * Broadcast requests were submitted as User requests.. Fixed ! * Bumped protocol version to latest (1.2.1) * Moved constants.ml to lastfm_constants.ml to avoid poluting the namespace. 0.1.2 (16-04-2008) ===== * Install .cmx file 0.1.1 (19-12-2007) ===== * Changed API: - Simply create a song record with get_song - Test wether your song record is valid for each submission type - submit and do_submit now return a list of songs that couldn't be submited, along with the explanation - get, do_np and do_submit now give another try when failed authentification can be due to caching inconsistency - anonymous get requests are somehow better handled when caching. However, you should not use get for multiple simultaneous anonymous streaming. + Better Radio protocol reversing, removed no longer available playlist url. + Close http connection when error is raised by underlying modul 0.1.0 (01-11-2007) ===== * Initial release ocaml-lastfm-0.3.4/COPYING000066400000000000000000000634761460160121500151440ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library 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 library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! ocaml-lastfm-0.3.4/README.md000066400000000000000000000014521460160121500153520ustar00rootroot00000000000000ocaml-lastfm This package contains an OCaml interface for Lastfm API interface. Please read the COPYING file before using this software. Prerequisites: ============== - ocaml - ocamlnet >= 2.2.8 (optional) - ocaml-xmlplaylist >= 0.1.0 - ocaml-pcre >= 5.12.2 - dune >= 2.0 Compilation: ============ ```sh dune build ``` This should build both the native and the byte-code version of the extension library. Installation: ============= Using [opam](http://opam.ocaml.org/): ```sh opam install lastfm ``` Using `dune` and a local copy (dev only): ```sh dune install ``` This should install the library file (using ocamlfind) in the appropriate place. Author: ======= This author of this software may be contacted by electronic mail at the following address: savonet-users@lists.sourceforge.net. ocaml-lastfm-0.3.4/dune-project000066400000000000000000000007511460160121500164160ustar00rootroot00000000000000(lang dune 3.6) (version 0.3.4) (name lastfm) (source (github savonet/ocaml-lastfm)) (license LGPL-2.1-or-later) (authors "Romain Beauxis ") (maintainers "The Savonet Team ") (generate_opam_files true) (package (name lastfm) (synopsis "The lastfm library is an implementation of the API used by the last.fm to keep count of played songs") (depends (ocaml (>= 4.08)) xmlplaylist (re (>= 1.11.0))) (depopts ocamlnet)) ocaml-lastfm-0.3.4/examples/000077500000000000000000000000001460160121500157075ustar00rootroot00000000000000ocaml-lastfm-0.3.4/examples/download.ml000066400000000000000000000030151460160121500200470ustar00rootroot00000000000000(* * Copyright 2007 Savonet team * * This file is part of OCaml-Vorbis. * * OCaml-Vorbis is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * OCaml-Vorbis 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 General Public License * along with OCaml-Vorbis; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *) open Nethttp_client let _ = try let uri = Sys.argv.(1) in let tracks = Lastfm.Radio.get uri in let metas, track = List.hd tracks in Printf.printf "Got track: %s\n" track; List.iter (fun (a, b) -> Printf.printf "Metadata: %s: %s\n" a b) metas; let filename = Printf.sprintf "%s - %s.mp3" (List.assoc "artist" metas) (List.assoc "title" metas) in Printf.printf "Downloading track to: %s" filename; flush stdout; let pipeline = new pipeline in let get_call = new get track in get_call#set_response_body_storage (`File (fun () -> filename)); pipeline#add get_call; pipeline#run () with Lastfm.Radio.Error e -> Printf.printf "Failed: %s" (Lastfm.Radio.string_of_error e) ocaml-lastfm-0.3.4/examples/dune000066400000000000000000000003541460160121500165670ustar00rootroot00000000000000(executable (name download) (modules download) (optional) (libraries threads netclient lastfm)) (executable (name request) (modules request) (libraries lastfm)) (executable (name submit) (modules submit) (libraries lastfm)) ocaml-lastfm-0.3.4/examples/request.ml000066400000000000000000000021571460160121500177360ustar00rootroot00000000000000(* * Copyright 2007 Savonet team * * This file is part of OCaml-Vorbis. * * OCaml-Vorbis is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * OCaml-Vorbis 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 General Public License * along with OCaml-Vorbis; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *) let _ = try let uri = Sys.argv.(1) in let tracks = Lastfm.Radio.get uri in let metas, track = List.hd tracks in Printf.printf "Got track: %s\n" track; List.iter (fun (a, b) -> Printf.printf "Metadata: %s: %s\n" a b) metas with Lastfm.Radio.Error e -> Printf.printf "Failed: %s" (Lastfm.Radio.string_of_error e) ocaml-lastfm-0.3.4/examples/submit.ml000066400000000000000000000030341460160121500175440ustar00rootroot00000000000000(* * Copyright 2007 Savonet team * * This file is part of OCaml-Vorbis. * * OCaml-Vorbis is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * OCaml-Vorbis 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 General Public License * along with OCaml-Vorbis; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *) open Lastfm.Audioscrobbler let _ = try let user, pass, title, artist, length = (Sys.argv.(1), Sys.argv.(2), Sys.argv.(3), Sys.argv.(4), Sys.argv.(5)) in let time = Unix.time () in let length = float_of_string length in let song = get_song ~time ~source:User ~length ~artist ~track:title () in let client = { Lastfm_generic.client = "tst"; version = "0.1" } in let login = { Lastfm_generic.user; password = pass } in do_np client login song; let failed = do_submit client login [song] in let print_failed (e, s) = Printf.printf "%s -- %s submission failed: %s" s.artist s.track (string_of_error e) in List.iter print_failed failed with Error e -> Printf.printf "Failed: %s\n" (string_of_error e) ocaml-lastfm-0.3.4/lastfm.opam000066400000000000000000000015061460160121500162370ustar00rootroot00000000000000# This file is generated by dune, edit dune-project instead opam-version: "2.0" version: "0.3.4" synopsis: "The lastfm library is an implementation of the API used by the last.fm to keep count of played songs" maintainer: ["The Savonet Team "] authors: ["Romain Beauxis "] license: "LGPL-2.1-or-later" homepage: "https://github.com/savonet/ocaml-lastfm" bug-reports: "https://github.com/savonet/ocaml-lastfm/issues" depends: [ "dune" {>= "3.6"} "ocaml" {>= "4.08"} "xmlplaylist" "re" {>= "1.11.0"} "odoc" {with-doc} ] depopts: ["ocamlnet"] build: [ ["dune" "subst"] {dev} [ "dune" "build" "-p" name "-j" jobs "@install" "@runtest" {with-test} "@doc" {with-doc} ] ] dev-repo: "git+https://github.com/savonet/ocaml-lastfm.git" ocaml-lastfm-0.3.4/src/000077500000000000000000000000001460160121500146605ustar00rootroot00000000000000ocaml-lastfm-0.3.4/src/dune000066400000000000000000000007131460160121500155370ustar00rootroot00000000000000(library (name lastfm) (public_name lastfm) (wrapped false) (libraries re xmlplaylist (select lastfm.ml from (threads netclient netstring -> lastfm.ocamlnet.ml) (-> lastfm.noop.ml))) (modules lastfm_constants lastfm_generic lastfm) (synopsis "Implementation of the API used by the last.fm to keep count of played songs")) (rule (target lastfm_constants.ml) (action (write-file %{target} "let version = \"%{version:lastfm}\""))) ocaml-lastfm-0.3.4/src/lastfm.noop.ml000066400000000000000000000000001460160121500174400ustar00rootroot00000000000000ocaml-lastfm-0.3.4/src/lastfm.ocamlnet.ml000066400000000000000000000051231460160121500203020ustar00rootroot00000000000000(***************************************************************************** Liquidsoap, a programmable audio stream generator. Copyright 2003-2007 Savonet team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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, fully stated in the COPYING file at the root of the liquidsoap distribution. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************) (* lastfm protocol API for ocaml *) module Http_ocamlnet = struct type request = Get | Post of string exception Http of string let default_timeout = ref 5. let request ?timeout ?(headers = []) ?(port = 80) ~host ~url ~request () = let timeout = match timeout with Some v -> v | None -> !default_timeout in let call = match request with | Get -> new Nethttp_client.get_call | Post _ -> new Nethttp_client.post_call in let pipeline = new Nethttp_client.pipeline in pipeline#set_options { (pipeline#get_options) with Nethttp_client.connection_timeout = timeout; }; let http_headers = call#request_header `Base in let body = call#request_body in call#set_request_uri (Printf.sprintf "http://%s:%d%s" host port url); let headers = ("User-agent", Printf.sprintf "ocaml-lastfm/%s" Lastfm_constants.version) :: headers in http_headers#set_fields headers; begin match request with | Get -> () | Post post -> body#set_value post; call#set_request_body body; http_headers#update_field "Content-length" (string_of_int (String.length post)) end; call#set_request_header http_headers; pipeline#add call; try pipeline#run (); call#response_body#value with Nethttp_client.Http_protocol e | e -> pipeline#reset (); raise (Http (Printexc.to_string e)) end module Audioscrobbler = Lastfm_generic.Audioscrobbler_generic (Http_ocamlnet) module Radio = Lastfm_generic.Radio_generic (Http_ocamlnet) ocaml-lastfm-0.3.4/src/lastfm.ocamlnet.mli000066400000000000000000000026471460160121500204630ustar00rootroot00000000000000(***************************************************************************** Liquidsoap, a programmable audio stream generator. Copyright 2003-2007 Savonet team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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, fully stated in the COPYING file at the root of the liquidsoap distribution. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************) (** API to various lastfm protocols (ocamlnet implementation). *) (** Implementation of the Http request using ocamlnet. *) module Http_ocamlnet : Lastfm_generic.Http_t (** Implementation of Audioscrobbler using the ocamlnet * Http request. *) module Audioscrobbler : Lastfm_generic.Audioscrobbler_t (** Implementation of the Radio API using the ocamlnet * Http request. *) module Radio : Lastfm_generic.Radio_t ocaml-lastfm-0.3.4/src/lastfm_generic.ml000066400000000000000000000552431460160121500202050ustar00rootroot00000000000000(***************************************************************************** Liquidsoap, a programmable audio stream generator. Copyright 2003-2010 Savonet team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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, fully stated in the COPYING file at the root of the liquidsoap distribution. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************) (* lastfm protocol API for ocaml *) module Pcre = Re.Pcre (* Records for client *) type client = { client : string; version : string } type login = { user : string; password : string } (** Decode Base64-encoded data *) let decode64 s = let padding = ref 0 in let to_int c = match c with | 'A' .. 'Z' -> int_of_char c - int_of_char 'A' | 'a' .. 'z' -> int_of_char c - int_of_char 'a' + 26 | '0' .. '9' -> int_of_char c - int_of_char '0' + 52 | '+' -> 62 | '/' -> 63 | '=' -> incr padding; 0 | _ -> failwith "decode64: invalid encoding" in let result = ref [] in let add x = result := char_of_int x :: !result in for i = 0 to (String.length s / 4) - 1 do (* Read 4 64-digits, i.e. 3 bytes. *) let c n = to_int s.[(i * 4) + n] in let i = c 3 + (c 2 lsl 6) + (c 1 lsl 12) + (c 0 lsl 18) in add ((i land 0xff0000) lsr 16); add ((i land 0x00ff00) lsr 8); add (i land 0x0000ff) done; let result = (* Remove up to two bytes depending on the padding. *) match !padding with | 0 -> !result | 1 -> List.tl !result | 2 -> List.tl (List.tl !result) | _ -> failwith "decode64: invalid encoding" in let len = List.length result in let s = Bytes.make len ' ' in ignore (List.fold_left (fun i c -> Bytes.set s i c; i - 1) (len - 1) result); Bytes.to_string s let parse_url s = let f h p r = (h, Some p, "/" ^ r) in try Scanf.sscanf s "http://%[^:]:%i/%[^\r^\n]" f with _ -> (* Retry without port *) let f h r = (h, None, "/" ^ r) in Scanf.sscanf s "http://%[^/]/%[^\r^\n]" f (* URL encoding/decoging according to RFC 1738, RFC 1630. * Borrowed from ocamlnet. *) let of_hex1 c = match c with | '0' .. '9' -> Char.code c - Char.code '0' | 'A' .. 'F' -> Char.code c - Char.code 'A' + 10 | 'a' .. 'f' -> Char.code c - Char.code 'a' + 10 | _ -> failwith "Error while decoding url.." let url_decode ?(plus = true) s = Pcre.substitute ~rex:(Pcre.regexp "\\+|%..") (* TODO why do we match %. and % and seem to exclude them below ? *) ~subst:(fun s -> if s = "+" then if plus then " " else "+" else begin (* Assertion: s.[0] = '%' *) if String.length s < 3 then failwith "Error while decoding url.."; let k1 = of_hex1 s.[1] in let k2 = of_hex1 s.[2] in String.make 1 (Char.chr ((k1 lsl 4) lor k2)) end) s (** Converts k to a 2-digit hexadecimal string. *) let to_hex2 = let hex_digits = [| '0'; '1'; '2'; '3'; '4'; '5'; '6'; '7'; '8'; '9'; 'A'; 'B'; 'C'; 'D'; 'E'; 'F'; |] in fun k -> let s = Bytes.create 2 in Bytes.set s 0 hex_digits.((k lsr 4) land 15); Bytes.set s 1 hex_digits.(k land 15); Bytes.to_string s let url_encode ?(plus = true) s = Pcre.substitute ~rex:(Pcre.regexp "[^A-Za-z0-9_.!*-]") ~subst:(fun x -> if plus && x = " " then "+" else ( let k = Char.code x.[0] in "%" ^ to_hex2 k)) s module type Http_t = sig type request = Get | Post of string exception Http of string val default_timeout : float ref val request : ?timeout:float -> ?headers:(string * string) list -> ?port:int -> host:string -> url:string -> request:request -> unit -> string end module type Audioscrobbler_t = sig type source = User | Broadcast | Recommendation | Lastfm | Unknown type rating = Love | Ban | Skip type action = NowPlaying | Submit type song = { artist : string; track : string; time : float option; source : source option; rating : rating option; length : float option; album : string option; trackauth : string option; tracknumber : int option; musicbrainzid : string option; } type error = | Http of string | Banned | Badauth | Badtime | Failed of string | UnknownError of string | Success | Internal of string | BadData of string exception Error of error val string_of_error : error -> string val base_port : int ref val base_host : string ref val get_song : ?time:float -> ?source:source -> ?rating:rating -> ?length:float -> ?album:string -> ?tracknumber:int -> ?musicbrainzid:string -> ?trackauth:string -> artist:string -> track:string -> unit -> song val check_song : song -> action -> unit val do_np : ?timeout:float -> ?host:string * int -> client -> login -> song -> unit val do_submit : ?timeout:float -> ?host:string * int -> client -> login -> song list -> (error * song) list val handshake : ?timeout:float -> ?host:string * int -> client -> login -> string val np : ?timeout:float -> string -> song -> unit val submit : ?timeout:float -> string -> song list -> (error * song) list end module Audioscrobbler_generic (Http : Http_t) = struct (* See http://www.audioscrobbler.net/development/protocol/ * For protocol description *) (* Data types *) type source = User | Broadcast | Recommendation | Lastfm | Unknown type rating = Love | Ban | Skip type action = NowPlaying | Submit (* song submission type *) type song = { artist : string; track : string; time : float option; source : source option; rating : rating option; length : float option; album : string option; trackauth : string option; tracknumber : int option; musicbrainzid : string option; } type error = | Http of string | Banned | Badauth | Badtime | Failed of string | UnknownError of string | Success | Internal of string | BadData of string exception Error of error let string_of_error e = match e with | Http s -> Printf.sprintf "http connection failed: %s" s | Banned -> "banned client" | Badauth -> "wrong login/password" | Badtime -> "wrong timestamp, check your clock" | Failed s -> Printf.sprintf "failure: %s" s | UnknownError s -> Printf.sprintf "unknown error: %s" s | Internal s -> Printf.sprintf "erreur interne: %s" s | BadData s -> Printf.sprintf "Wrong song data: %s" s | Success -> "success!" let parse_url s = try parse_url s with e -> raise (Error (Failed (Printf.sprintf "Error while parsing url: %s" (Printexc.to_string e)))) let error_of_response s = try let parse s = let regexp = Pcre.regexp "FAILED\\s([^\\r\\n]*)" in let sub = Pcre.exec ~rex:regexp s in Failed (Pcre.get_substring sub 1) in let test (p, e) = try ignore (Pcre.exec ~rex:(Pcre.regexp p) s); raise (Error e) with Not_found -> () in let values = [ ("OK", Success); ("BANNED", Banned); ("BADAUTH", Badauth); ("BADTIME", Badtime); ] in try List.iter test values; parse s with Error e -> e with Not_found -> UnknownError "unrecognized response code" (* We wrap Http.request to raise an internal exception. *) let request ?post ?timeout ?headers ?port ~host url = try let request = match post with Some "" | None -> Http.Get | Some v -> Http.Post v in Http.request ?timeout ?headers ?port ~host ~url ~request () with Http.Http s -> raise (Error (Http s)) (* Protocol constants *) let version = "1.2.1" let base_port = ref 80 let base_host = ref "post.audioscrobbler.com" let handshake_req = Printf.sprintf "/?hs=true&p=%s&c=%s&v=%s&u=%s&t=%s&a=%s" version (* sessions contains (user,pass) => id *) let sessions = Hashtbl.create 1 (* urls contains id => (np_url,submit_url) *) let urls = Hashtbl.create 1 let raise e = raise (Error e) let arg_value_string x = match x with Some e -> e | None -> "" let arg_value_int x = match x with Some e -> string_of_int e | None -> "" let arg_value_float x = match x with Some e -> Printf.sprintf "%.0f" e | None -> "" let clear sessionid = let keys = Hashtbl.fold (fun a b r -> if b = sessionid then a :: r else r) sessions [] in ignore (List.map (fun x -> Hashtbl.remove sessions x) keys); Hashtbl.remove urls sessionid let handshake ?timeout ?host client login = let client, version, user, pass = (client.client, client.version, login.user, login.password) in let host, port = match host with Some (x, y) -> (x, y) | None -> (!base_host, !base_port) in try Hashtbl.find sessions (user, pass, (host, port)) with Not_found -> ( let timestamp = Printf.sprintf "%.0f" (Unix.time ()) in let pass_digest = Digest.string pass in let token = Digest.string (Digest.to_hex pass_digest ^ timestamp) in let req = handshake_req client version user timestamp (Digest.to_hex token) in let ans = request ?timeout ~host ~port req in let state, id, v = try let lines = Pcre.split ~rex:(Pcre.regexp "[\r\n]+") ans in match lines with | [state; id; a; b] -> (state, id, (a, b)) | _ -> raise (error_of_response ans) with Not_found -> raise (error_of_response ans) in match error_of_response state with | Success -> Hashtbl.replace sessions (user, pass, (host, port)) id; Hashtbl.replace urls id v; id | e -> raise e) let check_song s a = match s.source with | None when a = Submit -> raise (BadData "source field is required for submit action") | _ -> ( (); match s.length with | None when a = Submit && s.source = Some User -> raise (BadData "length required when source is User") | _ -> ( (); match s.time with | None when s.source = Some User -> raise (BadData "time required when source is User") | _ -> ( (); match s.trackauth with | None when s.source = Some Lastfm -> raise (BadData "trackauth required when source is Lastfm") | _ -> ( (); match s.rating with | (Some Ban | Some Skip) when s.source <> Some Lastfm -> raise (BadData "bad rating value (ban and skip are for \ lastfm sources only)") | _ -> ())))) let audioscrobbler_post ?timeout id base_url values = let host, port, req = parse_url base_url in let port = match port with Some x -> x | None -> !base_port in let args = List.map (fun (a, b) -> Printf.sprintf "%s=%s" a (url_encode b)) values in let post = String.concat "&" args in let headers = [("Content-type", "application/x-www-form-urlencoded")] in let ans = request ?timeout ~post ~headers ~host ~port req in match error_of_response ans with | Success -> () | e -> clear id; raise e let np ?timeout id song = let url, _ = try Hashtbl.find urls id with Not_found -> raise Badauth in check_song song NowPlaying; let values = [ ("s", id); ("a", song.artist); ("t", song.track); ("album", arg_value_string song.album); ("l", arg_value_float song.length); ("n", arg_value_int song.tracknumber); ("m", arg_value_string song.musicbrainzid); ] in audioscrobbler_post ?timeout id url values let submit ?timeout id songs = let _, url = try Hashtbl.find urls id with Not_found -> raise (Internal (Printf.sprintf "No session data for session ID %s" id)) in let count = ref 0 in let failed = ref [] in let args = ref [("s", id)] in let get_arg s = Printf.sprintf "%s[%d]" s !count in let add_arg song = try check_song song Submit; let ar, tr, t, s, r, l, al, n, m, x = ( song.artist, song.track, song.time, song.source, song.rating, song.length, song.album, song.tracknumber, song.musicbrainzid, song.trackauth ) in let l = match l with None -> "" | Some s -> Printf.sprintf "%.0f" s in let t = match t with Some t -> Printf.sprintf "%.0f" t | None -> "" in let x = match x with Some x -> x | None -> "" in let s = match s with | Some User -> "P" | Some Broadcast -> "R" | Some Recommendation -> "E" | Some Lastfm -> "L" | Some Unknown -> "U" | None -> raise (Internal "source field is required for submit") in let r = match r with | Some Love -> "L" | Some Ban -> "B" | Some Skip -> "S" | None -> "" in args := [ (get_arg "a", ar); (get_arg "t", tr); (get_arg "i", t); (get_arg "o", s ^ x); (get_arg "r", r); (get_arg "l", l); (get_arg "b", arg_value_string al); (get_arg "n", arg_value_int n); (get_arg "m", arg_value_string m); ] @ !args with Error e -> failed := (e, song) :: !failed in List.iter add_arg songs; audioscrobbler_post ?timeout id url !args; !failed let get_song ?time ?source ?rating ?length ?album ?tracknumber ?musicbrainzid ?trackauth ~artist ~track () = { artist; track; time; source; rating; length; album; tracknumber; musicbrainzid; trackauth; } let do_np ?timeout ?host client login song = let id = handshake ?host client login in try np ?timeout id song with Error Badauth -> (* Retry in case of expired session id *) clear id; let id = handshake ?host client login in np id song let do_submit ?timeout ?host client login songs = let id = handshake ?host client login in try submit ?timeout id songs with Error Badauth -> (* Retry in case of expired session id *) clear id; let id = handshake ?host client login in submit id songs end module type Radio_t = sig type track = (string * string) list * string type error = | Http of string | Auth of string | Adjust of string * string | Playlist | Empty exception Error of error val string_of_error : error -> string val base_host : string ref val get : ?timeout:float -> string -> track list val parse : string -> login * string * string option val init : ?timeout:float -> login -> string val adjust : ?timeout:float -> string -> string -> (string * string) list val playlist : ?timeout:float -> string -> string option -> string val tracks : ?timeout:float -> string -> string option -> track list val clear : string -> unit end module Radio_generic (Http : Http_t) = struct (* Type for track datas * A track is a list of "field","value" metadatas * and an uri *) type track = (string * string) list * string type session = { login : login; station : ((string * string) list * string) option; base_url : string; playlist_url : string option; base_path : string; } type error = | Http of string | Auth of string | Adjust of string * string | Playlist | Empty exception Error of error exception Internal of string let string_of_error e = match e with | Http s -> Printf.sprintf "http connection failed: %s" s | Auth s -> Printf.sprintf "could not open session:\n%s" s | Adjust (s, s') -> Printf.sprintf "could not adjust station to %s:\n%s\nIs the URI valid ?" s s' | Playlist -> "error while parsing the playlist" | Empty -> "no files available" (* We wrap Http.request to raise an internal exception. *) let request ?post ?timeout ?headers ?port ~host url = try let request = match post with Some "" | None -> Http.Get | Some v -> Http.Post v in Http.request ?timeout ?headers ?port ~host ~url ~request () with Http.Http s -> raise (Error (Http s)) let parse_url s = try parse_url s with e -> raise (Error (Http (Printf.sprintf "Error while parsing url: %s" (Printexc.to_string e)))) let url_encode s = try url_encode s with | Failure s -> raise (Error (Http (Printf.sprintf "Error while parsing url: %s" s))) | e -> raise (Error (Http (Printf.sprintf "Error while parsing url: %s" (Printexc.to_string e)))) let _raise = raise let raise e = raise (Error e) (* Some constant for the protocol *) let base_host = ref "ext.last.fm" let sessions = Hashtbl.create 10 let registered_handshake = Printf.sprintf "/radio/handshake.php?username=%s&passwordmd5=%s" let station_set base id url = Printf.sprintf "%s/adjust.php?session=%s&url=%s" base id url let playlist_req id options = let d = try Hashtbl.find sessions id with Not_found -> raise (Auth (Printf.sprintf "No session registered for id %s" id)) in let options = match options with Some s -> s | None -> "" in let url = match d.playlist_url with | None -> "http://ws.audioscrobbler.com/radio/xspf.php" | Some s -> s in Printf.sprintf "%s?sk=%s&%s" url id options let playlist ?timeout id options = let url = playlist_req id options in let host, port, req = parse_url url in let port = match port with Some x -> x | None -> 80 in let data = request ?timeout ~port ~host req in let data = decode64 data in url_decode data (* Some parsing functions *) let parse_args s = let rex = Pcre.regexp "[&\n]" in let values = Pcre.split ~rex s in let split s l = try let sub = Pcre.exec ~rex:(Pcre.regexp "([^=]*)=(.*)") s in (Pcre.get_substring sub 1, Pcre.get_substring sub 2) :: l with Not_found -> l in List.fold_right split values [] let parse_handshake s = let params = parse_args s in try let f x = List.assoc x params in let g x = try Some (f x) with Not_found -> None in (f "session", g "playlist_url", f "base_url", f "base_path") with Not_found -> raise (Auth s) let adjust_pat = "response=OK" let check_adjust s = Pcre.pmatch ~rex:(Pcre.regexp adjust_pat) s let opt_split_rex = Pcre.regexp "^([^?]+)\\?(.+)$" let opt_parse s = try let sub = Pcre.exec ~rex:opt_split_rex s in (Pcre.get_substring sub 1, Some (Pcre.get_substring sub 2)) with Not_found -> (s, None) let auth_split_rex = Pcre.regexp "^lastfm://([^:]+):([^@]+)@(.+)$" let parse uri = try let sub = Pcre.exec ~rex:auth_split_rex uri in let data = Pcre.get_substring sub 3 in let station, options = opt_parse data in let user, password = (Pcre.get_substring sub 1, Pcre.get_substring sub 2) in ({ user; password }, Printf.sprintf "lastfm://%s" station, options) with Not_found -> raise (Auth "Could not find login/password.") (* Core stuff.. *) let clear id = Hashtbl.remove sessions id let init ?timeout login = try Hashtbl.iter (fun x d -> if d.login = login then _raise (Internal x)) sessions; _raise Not_found with | Not_found -> let user, password = (login.user, login.password) in let password = Digest.to_hex (Digest.string password) in let ret = request ?timeout ~host:!base_host (registered_handshake (url_encode user) password) in let id, playlist_url, base_url, base_path = parse_handshake ret in Hashtbl.replace sessions id { playlist_url; base_url; base_path; login; station = None }; id | Internal x -> x let adjust ?timeout id req = let d = try Hashtbl.find sessions id with Not_found -> raise (Auth (Printf.sprintf "No session registered for id %s" id)) in let base_url, base_path = (d.base_url, d.base_path) in match d.station with | Some (a, s) when s = req -> a | _ -> let http_req = station_set base_path id (url_encode req) in let ret = request ?timeout ~host:base_url http_req in if check_adjust ret then ( let args = parse_args ret in Hashtbl.replace sessions id { login = d.login; station = Some (args, req); playlist_url = d.playlist_url; base_url; base_path; }; args) else begin clear id; raise (Adjust (req, ret)) end let tracks ?timeout id options = try let playlist = playlist ?timeout id options in Xmlplaylist.tracks playlist with | Xmlplaylist.Error _ -> clear id; raise Playlist | Error e -> clear id; raise e let get ?timeout uri = let login, station, options = parse uri in let id = init ?timeout login in try ignore (adjust ?timeout id station); tracks ?timeout id options with Error _ -> (* Retry in case of expired session *) clear id; let id = init login in ignore (adjust id station); tracks id options end ocaml-lastfm-0.3.4/src/lastfm_generic.mli000066400000000000000000000213271460160121500203520ustar00rootroot00000000000000(***************************************************************************** Liquidsoap, a programmable audio stream generator. Copyright 2003-2010 Savonet team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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, fully stated in the COPYING file at the root of the liquidsoap distribution. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************) (** API to various lastfm protocols (generic modules). *) (** Records for login and client *) type client = { client : string; version : string } type login = { user : string; password : string } (** This is the type of Http request API * that the modules require. *) module type Http_t = sig type request = Get | Post of string exception Http of string val default_timeout : float ref val request : ?timeout:float -> ?headers:(string * string) list -> ?port:int -> host:string -> url:string -> request:request -> unit -> string end (** This is the type of the Audioscrobbler API. *) module type Audioscrobbler_t = sig (** Audioscrobbler is the submission protocol as described at {{:http://www.audioscrobbler.net/development/protocol/}http://www.audioscrobbler.net/development/protocol/} *) (** {2 Types} *) (** source of the track *) type source = User | Broadcast | Recommendation | Lastfm | Unknown (** possible rating for the track *) type rating = Love | Ban | Skip (** type of action *) type action = NowPlaying | Submit (** song submission type *) type song = { artist : string; track : string; time : float option; source : source option; rating : rating option; length : float option; album : string option; trackauth : string option; tracknumber : int option; musicbrainzid : string option; } (** various errors *) type error = | Http of string | Banned | Badauth | Badtime | Failed of string | UnknownError of string | Success | Internal of string | BadData of string exception Error of error (** Get meaning of Error e *) val string_of_error : error -> string (** Base port. Default: 80 *) val base_port : int ref (** Base host. Default: "post.audioscrobbler.com" *) val base_host : string ref (** {2 Common API} Functions common to both basic and advanced APIs *) (** [get_song] create a song record based on given values. Optional records can be ommited there. *) val get_song : ?time:float -> ?source:source -> ?rating:rating -> ?length:float -> ?album:string -> ?tracknumber:int -> ?musicbrainzid:string -> ?trackauth:string -> artist:string -> track:string -> unit -> song (** Check wether required song informations are supplied for given action. Raises [Error (BadData reason)] if invalid data is given. See protocol details there: {{:http://www.audioscrobbler.net/development/protocol/}http://www.audioscrobbler.net/development/protocol/} *) val check_song : song -> action -> unit (** {2 Basic API} Using this API, all requests are done in one single step *) (** [do_np client login song] execute a nowplaying request with authentification Optional host parameter is a pair "host",port to override the global values.*) val do_np : ?timeout:float -> ?host:string * int -> client -> login -> song -> unit (** [do_submit client login songs] execute a nowplaying request with authentification. This functions returns a list songs for which supplied informations were incomplete, with corresponding exception (see [check_song] source) *) val do_submit : ?timeout:float -> ?host:string * int -> client -> login -> song list -> (error * song) list (** {2 Advanced API} This API is for advanced usages. You may use it this way: {ol {- handshake : initiate session } {- np/submit: execute request } } The module will cache session informations and avoid redundant requests, so you might always call handshake. However, if a np or submit fails, it can be because the session has expired on server side, but the module cache still refered to it. So you might clear this session id, and try another handshake+submit/np. Check do_no and do_submit for examples. *) (** [handshake client login] open session, returns session ID Optional host parameter is a pair "host",port to override the global values. *) val handshake : ?timeout:float -> ?host:string * int -> client -> login -> string (** [np sessionID track] execute a nowplaying request *) val np : ?timeout:float -> string -> song -> unit (** [submit sessionID tracks] execute a submit request This functions returns a list songs for which supplied informations were incomplete, with corresponding exception (see check_song) *) val submit : ?timeout:float -> string -> song list -> (error * song) list end (** This is the type of the Radio API. *) module type Radio_t = sig (** API for using lastfm radios No protocol documentation avaible for now... *) (** {2 Types} *) (** Type for track datas A track is a list of "field","value" metadatas and an uri *) type track = (string * string) list * string (** Various errors *) type error = | Http of string | Auth of string | Adjust of string * string | Playlist | Empty exception Error of error (** Get meaning of Error e *) val string_of_error : error -> string (** Base host. Default: "ext.last.fm" *) val base_host : string ref (** {2 Basic API} *) (** [get uri] performs whole process and outputs a list of metadatas,uri from given lastfm uri. This function cannot handle well multiple anonymous requests. If you plan to play simultaneously several anonymous radios, you better use the advanced API to keep track of every opened session. *) val get : ?timeout:float -> string -> track list (** {2 Advanced API} Using this API you shall call: {ol {- parse: get required parts of the uri} {- init: initiate a session} {- adjust: adjust station } } Then you can use any of the following: {ul {- playlist: return the raw xml content of the playlist} {- tracks : returns the parsed playlist.}} After each of those calls, you shall use *only* one of the songs from the playlist. The module will cache session informations and avoid redundant requests, so you might always call init and adjust. If you call [playlist], and anything went bad, you have to call [clear] to remove cached data about this session. In any case you may also give another try, in case of inconsistent cached session data. See [get] source for details *) (** [parse uri] parse the given lastfm:// uri * * returns login,station,options *) val parse : string -> login * string * string option (** [init login] initiate lastfm session * * Returns the session id *) val init : ?timeout:float -> login -> string (** [adjust id station] adjusts lastfm station * for given session ID * * Returns a list of (variable,value) as returned * by the server. Contains settings for adjusted * radio. *) val adjust : ?timeout:float -> string -> string -> (string * string) list (** [playlist id] returns the raw xml content of the playlist *) val playlist : ?timeout:float -> string -> string option -> string (** [tracks id] * returns a list of metadatas,uri *) val tracks : ?timeout:float -> string -> string option -> track list (** [clear id] closes and clear all * informations about the given session ID *) val clear : string -> unit end (** Generic implementation of Audioscrobbler, independent * from the Http request. *) module Audioscrobbler_generic (_ : Http_t) : Audioscrobbler_t (** Generic implementation of the Radio API, independant * from the Http request. *) module Radio_generic (_ : Http_t) : Radio_t