diff options
36 files changed, 920 insertions, 284 deletions
diff --git a/.gitmodules b/.gitmodules index 3a037c31..e69de29b 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +0,0 @@ -[submodule "kcoreaddons"] - path = kcoreaddons - url = git://anongit.kde.org/kcoreaddons.git diff --git a/CMakeLists.txt b/CMakeLists.txt index 8b077275..1e5dae8f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -10,26 +10,10 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON) # Instruct CMake to run moc automatically when needed. set(CMAKE_AUTOMOC ON) -# Whether to build with the bundled KCoreAddons or system KCoreAddons -set( BUNDLE_KCOREADDONS "AUTO" CACHE STRING "Build own KCoreAddons, one of ON, OFF and AUTO" ) -set( KCOREADDONS_DIR "kcoreaddons" CACHE STRING "Local path to bundled KCoreAddons sources, if own KCoreAddons is built" ) - find_package(Qt5Core 5.2.0) # For JSON (de)serialization find_package(Qt5Network 5.2.0) # For networking find_package(Qt5Gui 5.2.0) # For userpics -if ( (NOT BUNDLE_KCOREADDONS STREQUAL "ON") - AND (NOT BUNDLE_KCOREADDONS STREQUAL "OFF") - AND (NOT BUNDLE_KCOREADDONS STREQUAL "AUTO") ) - message( FATAL_ERROR "BUNDLE_KCOREADDONS must be one of ON, OFF or AUTO" ) -endif () - -if ( BUNDLE_KCOREADDONS STREQUAL "AUTO" ) - find_package(KF5CoreAddons QUIET) -elseif ( BUNDLE_KCOREADDONS STREQUAL "OFF" ) - find_package(KF5CoreAddons REQUIRED) -endif () - message( STATUS ) message( STATUS "================================================================================" ) message( STATUS " libqmatrixclient Build Information " ) @@ -37,14 +21,6 @@ message( STATUS "=============================================================== message( STATUS "Building with: ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}" ) message( STATUS "Install Prefix: ${CMAKE_INSTALL_PREFIX}" ) message( STATUS "Path to Qt Core: ${Qt5Core_DIR}" ) -message( STATUS "Build own KCoreAddons (BUNDLE_KCOREADDONS): ${BUNDLE_KCOREADDONS}" ) -if ( NOT BUNDLE_KCOREADDONS STREQUAL "ON" ) - if ( KF5CoreAddons_FOUND ) - message( STATUS "'- Path to system KCoreAddons: ${KF5CoreAddons_DIR}" ) - else ( KF5CoreAddons_FOUND ) - message( STATUS "'- System KCoreAddons not found, using the bundled version at ${PROJECT_SOURCE_DIR}/${KCOREADDONS_DIR}" ) - endif ( KF5CoreAddons_FOUND ) -endif ( NOT BUNDLE_KCOREADDONS STREQUAL "ON" ) message( STATUS "================================================================================" ) message( STATUS ) @@ -78,17 +54,8 @@ set(libqmatrixclient_SRCS jobs/roommessagesjob.cpp jobs/syncjob.cpp jobs/mediathumbnailjob.cpp + jobs/logoutjob.cpp ) -# Add bundled KCoreAddons sources if we haven't found the system sources -# or if we ignore them -if ( NOT KF5CoreAddons_FOUND ) - set (libqmatrixclient_SRCS ${libqmatrixclient_SRCS} - ${KCOREADDONS_DIR}/src/lib/jobs/kjob.cpp - ${KCOREADDONS_DIR}/src/lib/jobs/kcompositejob.cpp - ${KCOREADDONS_DIR}/src/lib/jobs/kjobtrackerinterface.cpp - ${KCOREADDONS_DIR}/src/lib/jobs/kjobuidelegate.cpp - ) -endif ( NOT KF5CoreAddons_FOUND ) add_library(qmatrixclient ${libqmatrixclient_SRCS}) @@ -108,14 +75,3 @@ else ( CMAKE_VERSION VERSION_LESS "3.1" ) endif ( CMAKE_VERSION VERSION_LESS "3.1" ) target_link_libraries(qmatrixclient Qt5::Core Qt5::Network Qt5::Gui) -if ( KF5CoreAddons_FOUND ) - # The proper way of doing things would be to make a separate config.h.in - # file and use configure_file() command here to generate config.h with - # needed C++ preprocessor macros. If we have more than one or two - # dependencies like that, we should turn to that more scalable way. - # As for now, passing a macro through -D is easier to observe and maintain. - target_compile_definitions ( qmatrixclient PRIVATE USING_SYSTEM_KCOREADDONS ) - target_link_libraries(qmatrixclient KF5::CoreAddons) -else ( KF5CoreAddons_FOUND ) - include_directories( ${KCOREADDONS_DIR}/src/lib/jobs ) -endif ( KF5CoreAddons_FOUND ) diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..602bfc94 --- /dev/null +++ b/COPYING @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/connection.cpp b/connection.cpp index 8d916280..d6338191 100644 --- a/connection.cpp +++ b/connection.cpp @@ -23,7 +23,7 @@ #include "events/event.h" #include "room.h" #include "jobs/passwordlogin.h" -#include "jobs/geteventsjob.h" +#include "jobs/logoutjob.h" #include "jobs/postmessagejob.h" #include "jobs/postreceiptjob.h" #include "jobs/joinroomjob.h" @@ -98,6 +98,13 @@ void Connection::reconnect() loginJob->start(); } +void Connection::logout() +{ + auto job = new LogoutJob(d->data); + connect( job, &LogoutJob::success, this, &Connection::loggedOut); + job->start(); +} + SyncJob* Connection::sync(int timeout) { QString filter = "{\"room\": { \"timeline\": { \"limit\": 100 } } }"; @@ -109,8 +116,12 @@ SyncJob* Connection::sync(int timeout) d->processRooms(syncJob->roomData()); emit syncDone(); }); - connect( syncJob, &SyncJob::failure, - [=] () { emit connectionError(syncJob->errorString());}); + connect( syncJob, &SyncJob::failure, [=] () { + if (syncJob->error() == BaseJob::ContentAccessError) + emit loginError(syncJob->errorString()); + else + emit connectionError(syncJob->errorString()); + }); syncJob->start(); return syncJob; } diff --git a/connection.h b/connection.h index 452db198..f3a15cba 100644 --- a/connection.h +++ b/connection.h @@ -48,6 +48,8 @@ namespace QMatrixClient Q_INVOKABLE virtual void connectToServer( QString user, QString password ); Q_INVOKABLE virtual void connectWithToken( QString userId, QString token ); Q_INVOKABLE virtual void reconnect(); + Q_INVOKABLE virtual void logout(); + Q_INVOKABLE virtual SyncJob* sync(int timeout=-1); Q_INVOKABLE virtual void postMessage( Room* room, QString type, QString message ); Q_INVOKABLE virtual PostReceiptJob* postReceipt( Room* room, Event* event ); @@ -63,9 +65,11 @@ namespace QMatrixClient Q_INVOKABLE virtual QString token(); signals: + void resolved(); void connected(); void reconnected(); - void resolved(); + void loggedOut(); + void syncDone(); void newRoom(Room* room); void joinedRoom(Room* room); diff --git a/connectionprivate.cpp b/connectionprivate.cpp index 62840473..0f9f4539 100644 --- a/connectionprivate.cpp +++ b/connectionprivate.cpp @@ -23,7 +23,6 @@ #include "user.h" #include "jobs/passwordlogin.h" #include "jobs/syncjob.h" -#include "jobs/geteventsjob.h" #include "jobs/joinroomjob.h" #include "jobs/roommembersjob.h" #include "events/event.h" @@ -116,69 +115,7 @@ Room* ConnectionPrivate::provideRoom(QString id) return room; } -//void ConnectionPrivate::connectDone(KJob* job) -//{ -// PasswordLogin* realJob = static_cast<PasswordLogin*>(job); -// if( !realJob->error() ) -// { -// isConnected = true; -// userId = realJob->id(); -// qDebug() << "Our user ID: " << userId; -// emit q->connected(); -// } -// else { -// emit q->loginError( job->errorString() ); -// } -//} - -//void ConnectionPrivate::reconnectDone(KJob* job) -//{ -// PasswordLogin* realJob = static_cast<PasswordLogin*>(job); -// if( !realJob->error() ) -// { -// userId = realJob->id(); -// emit q->reconnected(); -// } -// else { -// emit q->loginError( job->errorString() ); -// isConnected = false; -// } -//} - -//void ConnectionPrivate::syncDone(KJob* job) -//{ -// SyncJob* syncJob = static_cast<SyncJob*>(job); -// if( !syncJob->error() ) -// { -// data->setLastEvent(syncJob->nextBatch()); -// processRooms(syncJob->roomData()); -// emit q->syncDone(); -// } -// else { -// if( syncJob->error() == BaseJob::NetworkError ) -// emit q->connectionError( syncJob->errorString() ); -// else -// qDebug() << "syncJob failed, error:" << syncJob->error(); -// } -//} - -//void ConnectionPrivate::gotJoinRoom(KJob* job) -//{ -// qDebug() << "gotJoinRoom"; -// JoinRoomJob* joinJob = static_cast<JoinRoomJob*>(job); -// if( !joinJob->error() ) -// { -// if ( Room* r = provideRoom(joinJob->roomId()) ) -// emit q->joinedRoom(r); -// } -// else -// { -// if( joinJob->error() == BaseJob::NetworkError ) -// emit q->connectionError( joinJob->errorString() ); -// } -//} - -void ConnectionPrivate::gotRoomMembers(KJob* job) +void ConnectionPrivate::gotRoomMembers(BaseJob* job) { RoomMembersJob* membersJob = static_cast<RoomMembersJob*>(job); if( !membersJob->error() ) diff --git a/connectionprivate.h b/connectionprivate.h index 8e37a934..d1199081 100644 --- a/connectionprivate.h +++ b/connectionprivate.h @@ -19,15 +19,12 @@ #ifndef QMATRIXCLIENT_CONNECTIONPRIVATE_H #define QMATRIXCLIENT_CONNECTIONPRIVATE_H -class KJob; - #include <QtCore/QObject> #include <QtCore/QHash> #include <QtCore/QJsonObject> #include "connection.h" #include "connectiondata.h" -#include "jobs/syncjob.h" namespace QMatrixClient { @@ -35,6 +32,8 @@ namespace QMatrixClient class Event; class State; class User; + class BaseJob; + class SyncRoomData; class ConnectionPrivate : public QObject { @@ -60,11 +59,7 @@ namespace QMatrixClient QString userId; public slots: -// void connectDone(KJob* job); -// void reconnectDone(KJob* job); -// void syncDone(KJob* job); -// void gotJoinRoom(KJob* job); - void gotRoomMembers(KJob* job); + void gotRoomMembers(BaseJob* job); }; } diff --git a/events/event.h b/events/event.h index a009aa99..72d26208 100644 --- a/events/event.h +++ b/events/event.h @@ -65,12 +65,12 @@ namespace QMatrixClient * @return an iterator to an item with the earliest timestamp after * the one of 'item'; or timeline.end(), if all events are earlier */ - template <class ItemT, template <typename> class ContT> - typename ContT<ItemT *>::iterator - findInsertionPos(ContT<ItemT *> & timeline, const ItemT *item) + template <class ItemT, class ContT> + typename ContT::iterator + findInsertionPos(ContT & timeline, const ItemT *item) { return std::lower_bound (timeline.begin(), timeline.end(), item, - [](const ItemT * a, const ItemT * b) { + [](const typename ContT::value_type a, const ItemT * b) { return a->timestamp() < b->timestamp(); } ); diff --git a/events/roommessageevent.cpp b/events/roommessageevent.cpp index b7459054..48f52453 100644 --- a/events/roommessageevent.cpp +++ b/events/roommessageevent.cpp @@ -171,7 +171,7 @@ RoomMessageEvent* RoomMessageEvent::fromJson(const QJsonObject& obj) { qDebug() << "RoomMessageEvent: unknown msgtype: " << msgtype; qDebug() << obj; - e->d->msgtype = MessageEventType::Unkown; + e->d->msgtype = MessageEventType::Unknown; e->d->content = new MessageEventContent; } diff --git a/events/roommessageevent.h b/events/roommessageevent.h index 939113d1..b0d5a1cb 100644 --- a/events/roommessageevent.h +++ b/events/roommessageevent.h @@ -27,7 +27,7 @@ namespace QMatrixClient { enum class MessageEventType { - Text, Emote, Notice, Image, File, Location, Video, Audio, Unkown + Text, Emote, Notice, Image, File, Location, Video, Audio, Unknown }; class MessageEventContent @@ -115,4 +115,4 @@ namespace QMatrixClient } -#endif // QMATRIXCLIENT_ROOMMESSAGEEVENT_H
\ No newline at end of file +#endif // QMATRIXCLIENT_ROOMMESSAGEEVENT_H diff --git a/jobs/basejob.cpp b/jobs/basejob.cpp index 50c85048..e0dff287 100644 --- a/jobs/basejob.cpp +++ b/jobs/basejob.cpp @@ -19,48 +19,56 @@ #include "basejob.h" #include <QtNetwork/QNetworkAccessManager> -#include <QtNetwork/QNetworkReply> #include <QtNetwork/QNetworkRequest> +#include <QtNetwork/QNetworkReply> +#include <QtNetwork/QSslError> #include <QtCore/QTimer> #include "../connectiondata.h" using namespace QMatrixClient; +struct NetworkReplyDeleter : public QScopedPointerDeleteLater +{ + static inline void cleanup(QNetworkReply* reply) + { + if (reply && reply->isRunning()) + reply->abort(); + QScopedPointerDeleteLater::cleanup(reply); + } +}; + class BaseJob::Private { public: Private(ConnectionData* c, JobHttpType t, bool nt) - : connection(c), reply(nullptr), type(t), needsToken(nt) {} + : connection(c), type(t), needsToken(nt) + , reply(nullptr), status(NoError) + {} ConnectionData* connection; - QNetworkReply* reply; JobHttpType type; bool needsToken; + + QScopedPointer<QNetworkReply, NetworkReplyDeleter> reply; + Status status; }; +inline QDebug operator<<(QDebug dbg, BaseJob* j) +{ + return dbg << "Job" << j->objectName(); +} + BaseJob::BaseJob(ConnectionData* connection, JobHttpType type, QString name, bool needsToken) : d(new Private(connection, type, needsToken)) { - // Work around KJob inability to separate success and failure signals - connect(this, &BaseJob::result, [this]() { - if (error() == NoError) - emit success(this); - else - emit failure(this); - }); setObjectName(name); + qDebug() << this << "created"; } BaseJob::~BaseJob() { - if( d->reply ) - { - if( d->reply->isRunning() ) - d->reply->abort(); - d->reply->deleteLater(); - } - delete d; + qDebug() << this << "destroyed"; } ConnectionData* BaseJob::connection() const @@ -78,10 +86,6 @@ QUrlQuery BaseJob::query() const return QUrlQuery(); } -void BaseJob::parseJson(const QJsonDocument& data) -{ -} - void BaseJob::start() { QUrl url = d->connection->baseUrl(); @@ -100,63 +104,127 @@ void BaseJob::start() switch( d->type ) { case JobHttpType::GetJob: - d->reply = d->connection->nam()->get(req); + d->reply.reset( d->connection->nam()->get(req) ); break; case JobHttpType::PostJob: - d->reply = d->connection->nam()->post(req, data.toJson()); + d->reply.reset( d->connection->nam()->post(req, data.toJson()) ); break; case JobHttpType::PutJob: - d->reply = d->connection->nam()->put(req, data.toJson()); + d->reply.reset( d->connection->nam()->put(req, data.toJson()) ); break; } - connect( d->reply, &QNetworkReply::sslErrors, this, &BaseJob::sslErrors ); - connect( d->reply, &QNetworkReply::finished, this, &BaseJob::gotReply ); + connect( d->reply.data(), &QNetworkReply::sslErrors, this, &BaseJob::sslErrors ); + connect( d->reply.data(), &QNetworkReply::finished, this, &BaseJob::gotReply ); QTimer::singleShot( 120*1000, this, SLOT(timeout()) ); // connect( d->reply, static_cast<void(QNetworkReply::*)(QNetworkReply::NetworkError)>(&QNetworkReply::error), // this, &BaseJob::networkError ); // http://doc.qt.io/qt-5/qnetworkreply.html#error-1 } -void BaseJob::fail(int errorCode, QString errorString) +void BaseJob::gotReply() { - setError( errorCode ); - setErrorText( errorString ); - if( d->reply->isRunning() ) - d->reply->abort(); - qWarning() << "Job" << objectName() << "failed:" << errorString; - emitResult(); + setStatus(checkReply(d->reply.data())); + if (status().good()) + setStatus(parseReply(d->reply->readAll())); + + finishJob(true); } -QNetworkReply* BaseJob::networkReply() const +BaseJob::Status BaseJob::checkReply(QNetworkReply* reply) const { - return d->reply; + switch( reply->error() ) + { + case QNetworkReply::NoError: + return NoError; + + case QNetworkReply::AuthenticationRequiredError: + case QNetworkReply::ContentAccessDenied: + case QNetworkReply::ContentOperationNotPermittedError: + return { ContentAccessError, reply->errorString() }; + + default: + return { NetworkError, reply->errorString() }; + } } -// void BaseJob::networkError(QNetworkReply::NetworkError code) -// { -// fail( KJob::UserDefinedError+1, d->reply->errorString() ); -// } +BaseJob::Status BaseJob::parseReply(QByteArray data) +{ + QJsonParseError error; + QJsonDocument json = QJsonDocument::fromJson(data, &error); + if( error.error == QJsonParseError::NoError ) + return parseJson(json); + else + return { JsonParseError, error.errorString() }; +} -void BaseJob::gotReply() +BaseJob::Status BaseJob::parseJson(const QJsonDocument&) +{ + return Success; +} + +void BaseJob::finishJob(bool emitResult) { - if( d->reply->error() != QNetworkReply::NoError ) + if (!d->reply) { - qDebug() << "NetworkError:" << d->reply->error(); - fail( NetworkError, d->reply->errorString() ); - return; + qWarning() << this << "finishes with empty network reply"; } - QJsonParseError error; - QJsonDocument data = QJsonDocument::fromJson(d->reply->readAll(), &error); - if( error.error != QJsonParseError::NoError ) + else if (d->reply->isRunning()) + { + qWarning() << this << "finishes without ready network reply"; + d->reply->disconnect(this); // Ignore whatever comes from the reply + } + + // Notify those that are interested in any completion of the job (including killing) + emit finished(this); + + if (emitResult) { + emit result(this); + if (error()) + emit failure(this); + else + emit success(this); + } + + deleteLater(); +} + +BaseJob::Status BaseJob::status() const +{ + return d->status; +} + +int BaseJob::error() const +{ + return d->status.code; +} + +QString BaseJob::errorString() const +{ + return d->status.message; +} + +void BaseJob::setStatus(Status s) +{ + d->status = s; + if (!s.good()) { - fail( JsonParseError, error.errorString() ); - return; + qWarning() << this << "status" << s.code << ":" << s.message; } - parseJson(data); +} + +void BaseJob::setStatus(int code, QString message) +{ + setStatus({ code, message }); +} + +void BaseJob::abandon() +{ + finishJob(false); } void BaseJob::timeout() { - fail( TimeoutError, "The job has timed out" ); + setStatus( TimeoutError, "The job has timed out" ); + finishJob(true); } void BaseJob::sslErrors(const QList<QSslError>& errors) diff --git a/jobs/basejob.h b/jobs/basejob.h index 98b7358b..07b1f1dd 100644 --- a/jobs/basejob.h +++ b/jobs/basejob.h @@ -19,16 +19,14 @@ #ifndef QMATRIXCLIENT_BASEJOB_H #define QMATRIXCLIENT_BASEJOB_H -#ifdef USING_SYSTEM_KCOREADDONS -#include <KCoreAddons/KJob> -#else -#include "kjob.h" -#endif // KCOREADDONS_FOUND - +#include <QtCore/QObject> #include <QtCore/QJsonDocument> #include <QtCore/QJsonObject> #include <QtCore/QUrlQuery> -#include <QtNetwork/QNetworkReply> +#include <QtCore/QScopedPointer> + +class QNetworkReply; +class QSslError; namespace QMatrixClient { @@ -36,27 +34,104 @@ namespace QMatrixClient enum class JobHttpType { GetJob, PutJob, PostJob }; - class BaseJob: public KJob + class BaseJob: public QObject { Q_OBJECT public: + /* Just in case, the values are compatible with KJob + * (which BaseJob used to inherit from). */ + enum StatusCode { NoError = 0 // To be compatible with Qt conventions + , Success = 0 + , ErrorLevel = 100 // Errors have codes starting from this + , NetworkError = 100 + , JsonParseError + , TimeoutError + , ContentAccessError + , UserDefinedError = 200 + }; + + /** + * This structure stores the status of a server call job. The status consists + * of a code, that is described (but not delimited) by the respective enum, + * and a freeform message. + * + * To extend the list of error codes, define an (anonymous) enum + * along the lines of StatusCode, with additional values + * starting at UserDefinedError + */ + class Status + { + public: + Status(StatusCode c) : code(c) { } + Status(int c, QString m) : code(c), message(m) { } + + bool good() const { return code < ErrorLevel; } + + int code; + QString message; + }; + + public: BaseJob(ConnectionData* connection, JobHttpType type, QString name, bool needsToken=true); virtual ~BaseJob(); - void start() override; + void start(); + + /** + * Abandons the result of this job, arrived or unarrived. + * + * This aborts waiting for a reply from the server (if there was + * any pending) and deletes the job object. It is always done quietly + * (as opposed to KJob::kill() that can trigger emitting the result). + */ + void abandon(); - enum ErrorCode { NetworkError = KJob::UserDefinedError, - JsonParseError, TimeoutError, UserDefinedError }; + Status status() const; + int error() const; + virtual QString errorString() const; signals: /** - * Emitted together with KJob::result() but only if there's no error. + * Emitted when the job is finished, in any case. It is used to notify + * observers that the job is terminated and that progress can be hidden. + * + * This should not be emitted directly by subclasses; + * use emitResult() instead. + * + * In general, to be notified of a job's completion, client code + * should connect to success() and failure() + * rather than finished(), so that kill() is indeed quiet. + * However if you store a list of jobs and they might get killed + * silently, then you must connect to this instead of result(), + * to avoid dangling pointers in your list. + * + * @param job the job that emitted this signal + * @internal + * + * @see success, failure + */ + void finished(BaseJob* job); + + /** + * Emitted when the job is finished (except when killed). + * + * Use error to know if the job was finished with error. + * + * @param job the job that emitted this signal + * + * @see success, failure + */ + void result(BaseJob* job); + + /** + * Emitted together with result() but only if there's no error. */ void success(BaseJob*); + /** - * Emitted together with KJob::result() if there's an error. - * Same as result(), this won't be emitted in case of kill(Quietly). + * Emitted together with result() if there's an error. + * Same as result(), this won't be emitted in case of kill(). */ void failure(BaseJob*); @@ -67,23 +142,55 @@ namespace QMatrixClient virtual QString apiPath() const = 0; virtual QUrlQuery query() const; virtual QJsonObject data() const; - virtual void parseJson(const QJsonDocument& data); - - void fail( int errorCode, QString errorString ); - QNetworkReply* networkReply() const; + /** + * Used by gotReply() slot to check the received reply for general + * issues such as network errors or access denial. + * Returning anything except NoError/Success prevents + * further parseReply()/parseJson() invocation. + * + * @param reply the reply received from the server + * @return the result of checking the reply + * + * @see gotReply + */ + virtual Status checkReply(QNetworkReply* reply) const; + + /** + * Processes the reply. By default, parses the reply into + * a QJsonDocument and calls parseJson() if it's a valid JSON. + * + * @param data raw contents of a HTTP reply from the server (without headers) + * + * @see gotReply, parseJson + */ + virtual Status parseReply(QByteArray data); + + /** + * Processes the JSON document received from the Matrix server. + * By default returns succesful status without analysing the JSON. + * + * @param json valid JSON document received from the server + * + * @see parseReply + */ + virtual Status parseJson(const QJsonDocument&); + void setStatus(Status s); + void setStatus(int code, QString message); + protected slots: - virtual void gotReply(); void timeout(); void sslErrors(const QList<QSslError>& errors); - //void networkError(QNetworkReply::NetworkError code); - + private slots: + void gotReply(); private: + void finishJob(bool emitResult); + class Private; - Private* d; + QScopedPointer<Private> d; }; } diff --git a/jobs/checkauthmethods.cpp b/jobs/checkauthmethods.cpp index 55d8632a..c93bf802 100644 --- a/jobs/checkauthmethods.cpp +++ b/jobs/checkauthmethods.cpp @@ -57,7 +57,8 @@ QString CheckAuthMethods::apiPath() const return "_matrix/client/r0/login"; } -void CheckAuthMethods::parseJson(const QJsonDocument& data) +BaseJob::Status CheckAuthMethods::parseJson(const QJsonDocument& data) { // TODO + return { BaseJob::StatusCode::UserDefinedError, "Not implemented" }; } diff --git a/jobs/checkauthmethods.h b/jobs/checkauthmethods.h index 197f7aa7..36eaa01a 100644 --- a/jobs/checkauthmethods.h +++ b/jobs/checkauthmethods.h @@ -27,7 +27,6 @@ namespace QMatrixClient class CheckAuthMethods : public BaseJob { - Q_OBJECT public: CheckAuthMethods(ConnectionData* connection); virtual ~CheckAuthMethods(); @@ -36,7 +35,7 @@ namespace QMatrixClient protected: QString apiPath() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/joinroomjob.cpp b/jobs/joinroomjob.cpp index 799d4926..8848aa70 100644 --- a/jobs/joinroomjob.cpp +++ b/jobs/joinroomjob.cpp @@ -54,18 +54,15 @@ QString JoinRoomJob::apiPath() const return QString("_matrix/client/r0/join/%1").arg(d->roomAlias); } -void JoinRoomJob::parseJson(const QJsonDocument& data) +BaseJob::Status JoinRoomJob::parseJson(const QJsonDocument& data) { QJsonObject json = data.object(); - if( !json.contains("room_id") ) - { - fail( BaseJob::UserDefinedError, "Something went wrong..." ); - qDebug() << data; - return; - } - else + if( json.contains("room_id") ) { d->roomId = json.value("room_id").toString(); + return Success; } - emitResult(); + + qDebug() << data; + return { UserDefinedError, "No room_id in the JSON response" }; } diff --git a/jobs/joinroomjob.h b/jobs/joinroomjob.h index 1329ca56..a6f4af21 100644 --- a/jobs/joinroomjob.h +++ b/jobs/joinroomjob.h @@ -35,7 +35,7 @@ namespace QMatrixClient protected: QString apiPath() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/logoutjob.cpp b/jobs/logoutjob.cpp new file mode 100644 index 00000000..88767e4c --- /dev/null +++ b/jobs/logoutjob.cpp @@ -0,0 +1,35 @@ +/****************************************************************************** + * Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net> + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include "logoutjob.h" + +using namespace QMatrixClient; + +LogoutJob::LogoutJob(ConnectionData* connection) + : BaseJob(connection, JobHttpType::PostJob, "LogoutJob") +{ +} + +LogoutJob::~LogoutJob() +{ +} + +QString LogoutJob::apiPath() const +{ + return "/_matrix/client/r0/logout"; +} diff --git a/jobs/logoutjob.h b/jobs/logoutjob.h new file mode 100644 index 00000000..faa1e2cb --- /dev/null +++ b/jobs/logoutjob.h @@ -0,0 +1,34 @@ +/****************************************************************************** + * Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net> + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#pragma once + +#include "basejob.h" + +namespace QMatrixClient +{ + class LogoutJob: public BaseJob + { + public: + LogoutJob(ConnectionData* connection); + virtual ~LogoutJob(); + + protected: + QString apiPath() const override; + }; +} diff --git a/jobs/mediathumbnailjob.cpp b/jobs/mediathumbnailjob.cpp index 48ed0ffb..1e434fbc 100644 --- a/jobs/mediathumbnailjob.cpp +++ b/jobs/mediathumbnailjob.cpp @@ -70,19 +70,11 @@ QUrlQuery MediaThumbnailJob::query() const return query; } -void MediaThumbnailJob::gotReply() +BaseJob::Status MediaThumbnailJob::parseReply(QByteArray data) { - if( networkReply()->error() != QNetworkReply::NoError ) - { - qDebug() << "NetworkError!!!"; - qDebug() << networkReply()->errorString(); - fail( NetworkError, networkReply()->errorString() ); - return; - } - - if( !d->thumbnail.loadFromData( networkReply()->readAll() ) ) + if( !d->thumbnail.loadFromData(data) ) { qDebug() << "MediaThumbnailJob: could not read image data"; } - emitResult(); + return Success; } diff --git a/jobs/mediathumbnailjob.h b/jobs/mediathumbnailjob.h index df7c1832..3babf845 100644 --- a/jobs/mediathumbnailjob.h +++ b/jobs/mediathumbnailjob.h @@ -29,7 +29,6 @@ namespace QMatrixClient class MediaThumbnailJob: public BaseJob { - Q_OBJECT public: MediaThumbnailJob(ConnectionData* data, QUrl url, int requestedWidth, int requestedHeight, ThumbnailType thumbnailType=ThumbnailType::Scale); @@ -41,8 +40,7 @@ namespace QMatrixClient QString apiPath() const override; QUrlQuery query() const override; - protected slots: - void gotReply() override; + Status parseReply(QByteArray data) override; private: class Private; diff --git a/jobs/passwordlogin.cpp b/jobs/passwordlogin.cpp index 231dcce5..c85e4c13 100644 --- a/jobs/passwordlogin.cpp +++ b/jobs/passwordlogin.cpp @@ -80,15 +80,15 @@ QJsonObject PasswordLogin::data() const return json; } -void PasswordLogin::parseJson(const QJsonDocument& data) +BaseJob::Status PasswordLogin::parseJson(const QJsonDocument& data) { QJsonObject json = data.object(); if( !json.contains("access_token") || !json.contains("home_server") || !json.contains("user_id") ) { - fail( BaseJob::UserDefinedError, "Unexpected data" ); + return { UserDefinedError, "No expected data" }; } d->returned_token = json.value("access_token").toString(); d->returned_server = json.value("home_server").toString(); d->returned_id = json.value("user_id").toString(); - emitResult(); + return Success; } diff --git a/jobs/passwordlogin.h b/jobs/passwordlogin.h index 5e93e74e..d7e42725 100644 --- a/jobs/passwordlogin.h +++ b/jobs/passwordlogin.h @@ -27,7 +27,6 @@ namespace QMatrixClient class PasswordLogin : public BaseJob { - Q_OBJECT public: PasswordLogin(ConnectionData* connection, QString user, QString password); virtual ~PasswordLogin(); @@ -39,7 +38,7 @@ namespace QMatrixClient protected: QString apiPath() const override; QJsonObject data() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/postmessagejob.cpp b/jobs/postmessagejob.cpp index cf9b94fd..0a38da62 100644 --- a/jobs/postmessagejob.cpp +++ b/jobs/postmessagejob.cpp @@ -61,14 +61,11 @@ QJsonObject PostMessageJob::data() const return json; } -void PostMessageJob::parseJson(const QJsonDocument& data) +BaseJob::Status PostMessageJob::parseJson(const QJsonDocument& data) { - QJsonObject json = data.object(); - if( !json.contains("event_id") ) - { - fail( BaseJob::UserDefinedError, "Something went wrong..." ); - qDebug() << data; - return; - } - emitResult(); + if( data.object().contains("event_id") ) + return Success; + + qDebug() << data; + return { UserDefinedError, "No event_id in the JSON response" }; } diff --git a/jobs/postmessagejob.h b/jobs/postmessagejob.h index 1917ef25..73d72020 100644 --- a/jobs/postmessagejob.h +++ b/jobs/postmessagejob.h @@ -26,7 +26,6 @@ namespace QMatrixClient class Room; class PostMessageJob: public BaseJob { - Q_OBJECT public: PostMessageJob(ConnectionData* connection, Room* room, QString type, QString message); virtual ~PostMessageJob(); @@ -36,7 +35,7 @@ namespace QMatrixClient protected: QString apiPath() const override; QJsonObject data() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/postreceiptjob.h b/jobs/postreceiptjob.h index c5224af5..15963bf7 100644 --- a/jobs/postreceiptjob.h +++ b/jobs/postreceiptjob.h @@ -26,7 +26,6 @@ namespace QMatrixClient class Room; class PostReceiptJob: public BaseJob { - Q_OBJECT public: PostReceiptJob(ConnectionData* connection, QString roomId, QString eventId); virtual ~PostReceiptJob(); diff --git a/jobs/roommembersjob.cpp b/jobs/roommembersjob.cpp index c16ba481..7fc44c63 100644 --- a/jobs/roommembersjob.cpp +++ b/jobs/roommembersjob.cpp @@ -20,6 +20,7 @@ #include <QtCore/QJsonObject> #include <QtCore/QJsonArray> +#include <QtCore/QDebug> #include "../room.h" #include "../state.h" @@ -55,10 +56,9 @@ QString RoomMembersJob::apiPath() const return QString("_matrix/client/r0/rooms/%1/members").arg(d->room->id()); } -void RoomMembersJob::parseJson(const QJsonDocument& data) +BaseJob::Status RoomMembersJob::parseJson(const QJsonDocument& data) { - QJsonObject obj = data.object(); - QJsonArray chunk = obj.value("chunk").toArray(); + QJsonArray chunk = data.object().value("chunk").toArray(); for( const QJsonValue& val : chunk ) { State* state = State::fromJson(val.toObject()); @@ -66,5 +66,5 @@ void RoomMembersJob::parseJson(const QJsonDocument& data) d->states.append(state); } qDebug() << "States: " << d->states.count(); - emitResult(); + return Success; } diff --git a/jobs/roommembersjob.h b/jobs/roommembersjob.h index ffae4309..04803d67 100644 --- a/jobs/roommembersjob.h +++ b/jobs/roommembersjob.h @@ -35,8 +35,8 @@ namespace QMatrixClient QList<State*> states(); protected: - virtual QString apiPath() const override; - virtual void parseJson(const QJsonDocument& data) override; + QString apiPath() const override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/roommessagesjob.cpp b/jobs/roommessagesjob.cpp index f1943d2c..ba075007 100644 --- a/jobs/roommessagesjob.cpp +++ b/jobs/roommessagesjob.cpp @@ -81,10 +81,10 @@ QUrlQuery RoomMessagesJob::query() const return query; } -void RoomMessagesJob::parseJson(const QJsonDocument& data) +BaseJob::Status RoomMessagesJob::parseJson(const QJsonDocument& data) { QJsonObject obj = data.object(); d->events = eventListFromJson(obj.value("chunk").toArray()); d->end = obj.value("end").toString(); - emitResult(); + return Success; } diff --git a/jobs/roommessagesjob.h b/jobs/roommessagesjob.h index 6160dc57..52a72f70 100644 --- a/jobs/roommessagesjob.h +++ b/jobs/roommessagesjob.h @@ -30,7 +30,6 @@ namespace QMatrixClient class RoomMessagesJob: public BaseJob { - Q_OBJECT public: RoomMessagesJob(ConnectionData* data, Room* room, QString from, FetchDirectory dir = FetchDirectory::Backwards, int limit=10); virtual ~RoomMessagesJob(); @@ -41,7 +40,7 @@ namespace QMatrixClient protected: QString apiPath() const override; QUrlQuery query() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; diff --git a/jobs/syncjob.cpp b/jobs/syncjob.cpp index 37f79298..3bd1f0c8 100644 --- a/jobs/syncjob.cpp +++ b/jobs/syncjob.cpp @@ -43,8 +43,10 @@ class SyncJob::Private QList<SyncRoomData> roomData; }; +static size_t jobId = 0; + SyncJob::SyncJob(ConnectionData* connection, QString since) - : BaseJob(connection, JobHttpType::GetJob, "SyncJob") + : BaseJob(connection, JobHttpType::GetJob, QString("SyncJob-%1").arg(++jobId)) , d(new Private) { d->since = since; @@ -108,7 +110,7 @@ QUrlQuery SyncJob::query() const return query; } -void SyncJob::parseJson(const QJsonDocument& data) +BaseJob::Status SyncJob::parseJson(const QJsonDocument& data) { QJsonObject json = data.object(); d->nextBatch = json.value("next_batch").toString(); @@ -132,7 +134,7 @@ void SyncJob::parseJson(const QJsonDocument& data) } } - emitResult(); + return Success; } void SyncRoomData::EventList::fromJson(const QJsonObject& roomContents) diff --git a/jobs/syncjob.h b/jobs/syncjob.h index 19dd4646..6e6b4f7c 100644 --- a/jobs/syncjob.h +++ b/jobs/syncjob.h @@ -58,7 +58,6 @@ namespace QMatrixClient class ConnectionData; class SyncJob: public BaseJob { - Q_OBJECT public: SyncJob(ConnectionData* connection, QString since=QString()); virtual ~SyncJob(); @@ -74,7 +73,7 @@ namespace QMatrixClient protected: QString apiPath() const override; QUrlQuery query() const override; - void parseJson(const QJsonDocument& data) override; + Status parseJson(const QJsonDocument& data) override; private: class Private; @@ -82,4 +81,4 @@ namespace QMatrixClient }; } -#endif // QMATRIXCLIENT_GETEVENTSJOB_H +#endif // QMATRIXCLIENT_SYNCJOB_H diff --git a/kcoreaddons b/kcoreaddons deleted file mode 160000 -Subproject 7ac7a605923f0bb2f0f367f6069a101a24bead9 diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri index 1290aa19..2648ac6b 100644 --- a/libqmatrixclient.pri +++ b/libqmatrixclient.pri @@ -32,10 +32,7 @@ HEADERS += \ $$PWD/jobs/roommessagesjob.h \ $$PWD/jobs/syncjob.h \ $$PWD/jobs/mediathumbnailjob.h \ - $$PWD/kcoreaddons/src/lib/jobs/kjob.h \ - $$PWD/kcoreaddons/src/lib/jobs/kcompositejob.h \ - $$PWD/kcoreaddons/src/lib/jobs/kjobtrackerinterface.h \ - $$PWD/kcoreaddons/src/lib/jobs/kjobuidelegate.h + $$PWD/jobs/logoutjob.h SOURCES += \ $$PWD/connectiondata.cpp \ @@ -66,7 +63,4 @@ SOURCES += \ $$PWD/jobs/roommessagesjob.cpp \ $$PWD/jobs/syncjob.cpp \ $$PWD/jobs/mediathumbnailjob.cpp \ - $$PWD/kcoreaddons/src/lib/jobs/kjob.cpp \ - $$PWD/kcoreaddons/src/lib/jobs/kcompositejob.cpp \ - $$PWD/kcoreaddons/src/lib/jobs/kjobtrackerinterface.cpp \ - $$PWD/kcoreaddons/src/lib/jobs/kjobuidelegate.cpp + $$PWD/jobs/logoutjob.cpp @@ -41,7 +41,7 @@ using namespace QMatrixClient; -class Room::Private: public QObject +class Room::Private { public: /** Map of user names to users. User names potentially duplicate, hence a multi-hashmap. */ @@ -52,9 +52,10 @@ class Room::Private: public QObject Room* q; //static LogMessage* parseMessage(const QJsonObject& message); - void gotMessages(KJob* job); - // This updates the room displayname field (which is the way a room should be shown in the room list) - // It should be called whenever the list of members or the room name (m.room.name) or canonical alias change. + + // This updates the room displayname field (which is the way a room + // should be shown in the room list) It should be called whenever the + // list of members or the room name (m.room.name) or canonical alias change. void updateDisplayname(); Connection* connection; @@ -75,9 +76,9 @@ class Room::Private: public QObject QString prevBatch; RoomMessagesJob* roomMessagesJob; - // Convenience methods to work with the membersMap and usersLeft. addMember() - // and removeMember() emit respective Room:: signals after a succesful - // operation. + // Convenience methods to work with the membersMap and usersLeft. + // addMember() and removeMember() emit respective Room:: signals + // after a succesful operation. //void inviteUser(User* u); // We might get it at some point in time. void addMember(User* u); bool hasMember(User* u) const; @@ -110,7 +111,7 @@ Room::Room(Connection* connection, QString id) Room::~Room() { - qDebug() << "deconstructing room" << this; + qDebug() << "deconstructing room" << id(); delete d; } @@ -324,6 +325,11 @@ QString Room::roomMembername(User *u) const return username % " <" % u->id() % ">"; } +QString Room::roomMembername(QString userId) const +{ + return roomMembername(connection()->user(userId)); +} + void Room::addMessage(Event* event) { processMessageEvent(event); @@ -398,7 +404,7 @@ void Room::Private::getPreviousContent() } } -Connection* Room::connection() +Connection* Room::connection() const { return d->connection; } @@ -497,7 +503,7 @@ QString Room::Private::roomNameFromMemberNames(const QList<User *> &userlist) co // the current one to render the name of the room. // std::array is the leanest C++ container - std::array<User*, 2> first_two { nullptr, nullptr }; + std::array<User*, 2> first_two = { {nullptr, nullptr} }; std::partial_sort_copy( userlist.begin(), userlist.end(), first_two.begin(), first_two.end(), @@ -20,6 +20,7 @@ #define QMATRIXCLIENT_ROOM_H #include <QtCore/QList> +#include <QtCore/QStringList> #include <QtCore/QObject> #include <QtCore/QJsonObject> @@ -55,9 +56,14 @@ namespace QMatrixClient /** * @brief Produces a disambiguated name for a given user in - * the context of the room. + * the context of the room */ Q_INVOKABLE QString roomMembername(User* u) const; + /** + * @brief Produces a disambiguated name for a user with this id in + * the context of the room + */ + Q_INVOKABLE QString roomMembername(QString userId) const; Q_INVOKABLE void addMessage( Event* event ); Q_INVOKABLE void addInitialState( State* state ); @@ -95,7 +101,7 @@ namespace QMatrixClient void notificationCountChanged(Room* room); protected: - Connection* connection(); + Connection* connection() const; virtual void processMessageEvent(Event* event); virtual void processStateEvent(Event* event); virtual void processEphemeralEvent(Event* event); @@ -25,6 +25,7 @@ #include <QtCore/QTimer> #include <QtCore/QPair> +#include <QtCore/QDebug> using namespace QMatrixClient; |