Initial commit master v1.0.0
authorIain Nicol <iain@iainnicol.com>
Sat, 14 Jun 2014 19:14:59 +0000 (20:14 +0100)
committerIain Nicol <iain@iainnicol.com>
Sat, 14 Jun 2014 19:14:59 +0000 (20:14 +0100)
Implement the program, which seems to work.  Implement tests to backup
this claim.

.gitignore [new file with mode: 0644]
INSTALL [new file with mode: 0644]
LICENSE [new file with mode: 0644]
README [new file with mode: 0644]
build.sbt [new file with mode: 0644]
project/build.properties [new file with mode: 0644]
src/main/scala/com/iainnicol/imapreorder/Imap.scala [new file with mode: 0644]
src/main/scala/com/iainnicol/imapreorder/Main.scala [new file with mode: 0644]
src/main/scala/com/iainnicol/imapreorder/Reorder.scala [new file with mode: 0644]
src/main/scala/com/iainnicol/imapreorder/Tmp.scala [new file with mode: 0644]
src/test/scala/ReorderTest.scala [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..2f7896d
--- /dev/null
@@ -0,0 +1 @@
+target/
diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..35e0db3
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,42 @@
+Copyright © 2014 Iain Nicol
+See the end of the file for license conditions.
+
+
+To compile and use imapreorder you must first you must install sbt.  sbt
+is a build system for Scala programs.[1]
+
+After installing sbt, open up a console in the root directory of the
+imapreorder source code.
+
+We should test imapreorder before proceeding.  The tests should work on
+GNU/Linux as long as you have the Dovecot IMAP server installed.  You do
+not need any Dovecot service to be running, nor will the tests interfere
+with any emails or data you may be storing with Dovecot; the tests, of
+course, are isolated.
+
+To run the tests, run the command
+  $ sbt test
+Tests may take a few minutes to pass.  The good news is that, if they
+were to instead fail, they would likely fail much faster than that.
+
+You can compile and run imapreorder without installing it.  For example,
+run the command
+  $ sbt "run --host HOST --username USER --password PASS --folder FOLDER"
+Obviously, substitute in the correct command line arguments.
+
+[1] See <http://www.scala-sbt.org/index.html>.
+
+
+\f
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any lather 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..dba13ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, 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
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state 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 program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..0375055
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+Copyright © 2014 Iain Nicol
+See the end of the file for license conditions.
+
+
+imapreorder is a command line program.  It will reorder the emails of an
+IMAP folder.  The postcondition is that if your emails are then sorted
+by UID, they will also be sorted by their received date.  In IMAP
+jargon, the received date is also called the ``internal date'' or
+``INTERNALDATE''.
+
+imapreorder is useful because the K-9 email client for Android sorts
+messages by UID, not by their internal date.[1]  In other words, running
+imapreorder will ensure that K-9 displays your messages in the correct
+order.
+
+The program imapreorder is designed to operate safely.  In particular,
+consider the effect of it being interrupted, for example by a network
+failure.  You would then have to delete an obviously-named temporary
+email-subfolder.  Additionally, you would need to use a program such as
+imapsync[2] to safely remove duplicated messages from your email folder.
+However, you should not lose any emails.
+
+imapreorder is free software; see the file COPYING.
+
+For compilation instructions, see the file INSTALL.
+
+
+[1] See <https://code.google.com/p/k9mail/issues/detail?id=1072>.
+
+[2] See <http://imapsync.lamiral.info/>.
+
+
+\f
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any lather 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/build.sbt b/build.sbt
new file mode 100644 (file)
index 0000000..1b6b1c3
--- /dev/null
+++ b/build.sbt
@@ -0,0 +1,30 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+name := "imapreorder"
+
+version := "1.0.0"
+
+scalaVersion := "2.11.1"
+
+libraryDependencies ++= Seq(
+  "com.github.nscala-time" %% "nscala-time" % "1.2.0" % "test",
+  "com.jsuereth" %% "scala-arm" % "1.4",
+  "com.sun.mail" % "javax.mail" % "1.5.2",
+  "javax.mail" % "javax.mail-api" % "1.5.2",
+  "org.apache.directory.studio" % "org.apache.commons.io" % "2.4",
+  "org.rogach" %% "scallop" % "0.9.5",
+  "org.scalacheck" %% "scalacheck" % "1.11.4" % "test"
+)
diff --git a/project/build.properties b/project/build.properties
new file mode 100644 (file)
index 0000000..7663416
--- /dev/null
@@ -0,0 +1,16 @@
+# Copyright © 2014 Iain Nicol
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+sbt.version=0.13.5
diff --git a/src/main/scala/com/iainnicol/imapreorder/Imap.scala b/src/main/scala/com/iainnicol/imapreorder/Imap.scala
new file mode 100644 (file)
index 0000000..d5e808a
--- /dev/null
@@ -0,0 +1,149 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package com.iainnicol.imapreorder
+
+import com.sun.mail.imap.{AppendUID, IMAPFolder, IMAPMessage, IMAPStore}
+import javax.mail._
+import scala.collection.immutable.Seq
+import resource.{ManagedResource, makeManagedResource}
+
+/** General purpose IMAP functions.  A lot of functions are simple
+  * wrappers round javamail functions, allowing code with better type
+  * safety to be written.
+  */
+object Imap {
+
+  object Protocol extends Enumeration {
+    type Protocol = Value
+    val imap, imaps = Value
+  }
+
+  /** Copies the messages.  Preserves their INTERNALDATEs.
+    *
+    * @param source source folder; must be open.
+    * @param dest destination folder; must be open.
+    * @return the copies.
+    */
+  def copy(
+    messages: Seq[IMAPMessage],
+    source: IMAPFolder,
+    dest: IMAPFolder): Seq[IMAPMessage] = {
+    val copyUids: Seq[AppendUID] =
+      source.copyUIDMessages(messages.toArray, dest).toVector
+    assert(copyUids != null)
+    assert(copyUids.length == messages.length)
+    val destUidValidity: Long = dest.getUIDValidity
+    for (copyUid <- copyUids) {
+      assert(copyUid != null)
+      assert(copyUid.uidvalidity == destUidValidity)
+    }
+
+    var msgsCopy: Seq[IMAPMessage] = getMessagesByUid(
+      dest,
+      copyUids.map(_.uid).toArray)
+    // Sometimes we have to try a second time.  WTF.
+    if (msgsCopy.exists(_ == null)) {
+      msgsCopy = getMessagesByUid(
+        dest,
+        copyUids.map(_.uid).toArray)
+    }
+    assert(msgsCopy.forall(_ != null))
+    return msgsCopy
+  }
+
+  /** Sets the deleted flag on the messages.
+    *
+    * @param folder folder containing the messages.
+    */
+  def deleteMessages(
+    folder: IMAPFolder,
+    messages: Iterable[IMAPMessage]): Unit = {
+    folder.setFlags(
+      messages.toArray: Array[Message],
+      new Flags(Flags.Flag.DELETED), true)
+  }
+
+  /** Fetches metadata about the messages, in one batch.  Note that the
+    * input messages will be mutated to contain said data.
+    */
+  def fetchMetadata(
+    messages: Iterable[IMAPMessage],
+    folder: IMAPFolder): Seq[IMAPMessage] = {
+    var fetchProfile = new FetchProfile();
+    // ENVELOPE also causes INTERNALDATE to be fetched:
+    fetchProfile.add(FetchProfile.Item.ENVELOPE);
+    fetchProfile.add(UIDFolder.FetchProfileItem.UID)
+    val myMessages: Seq[IMAPMessage] = messages.toVector
+    folder.fetch(myMessages.toArray, fetchProfile);
+    myMessages
+  }
+
+  /** Gets all the messages in the folder.
+    */
+  def getMessages(folder: IMAPFolder): Seq[IMAPMessage] = {
+    folder.getMessages.map(_.asInstanceOf[IMAPMessage]).toVector
+  }
+
+  /** Gets the messages from the folder for the given UIDs.
+    */
+  def getMessagesByUid(
+    folder: IMAPFolder,
+    uids: Iterable[Long]): Seq[IMAPMessage] = {
+    folder.getMessagesByUID(uids.toArray)
+      .map(_.asInstanceOf[IMAPMessage])
+      .toVector
+  }
+
+  /** Returns an open folder with the given name.  This is a resource is
+    * usable with the scala-arm library.  Upon release, closes the
+    * directory.
+    *
+    * @param store store which directly contains the folder.
+    * @param folderName name of the folder.
+    * @param mode used when opening the folder.
+    */
+  def getFolder(
+    store: IMAPStore,
+    folderName: String,
+    mode: Int) : ManagedResource[IMAPFolder] = {
+    val folder: IMAPFolder =
+      store.getFolder(folderName).asInstanceOf[IMAPFolder]
+    folder.open(mode)
+    val resource = makeManagedResource(folder)({ folder =>
+      folder.close(false /* Expunge flag */) })(List())
+    resource
+  }
+
+  /** Returns a store for the IMAP protocol.
+    */
+  def getImapStore(session: Session): IMAPStore = {
+    session.getStore("imap").asInstanceOf[IMAPStore]
+  }
+
+  /* Returns a store for IMAPS, that is IMAP over SSL or TLS.
+   */
+  def getImapsStore(session: Session): IMAPStore = {
+    session.getStore("imaps").asInstanceOf[IMAPStore]
+  }
+
+  /* Returns a store for the protocol. */
+  def getStore(session: Session, protocol: Protocol.Value): IMAPStore = {
+    protocol match {
+      case Protocol.imap => getImapStore(session)
+      case Protocol.imaps => getImapsStore(session)
+    }
+  }
+}
diff --git a/src/main/scala/com/iainnicol/imapreorder/Main.scala b/src/main/scala/com/iainnicol/imapreorder/Main.scala
new file mode 100644 (file)
index 0000000..63a9be4
--- /dev/null
@@ -0,0 +1,112 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package com.iainnicol.imapreorder
+
+import javax.mail.Session
+import org.rogach.scallop
+import resource.managed
+
+/** Contains the program entry point.
+  */
+object Main {
+
+  /** Program entry point.
+    */
+  def main(args: Array[String]): Unit = {
+    val conf = new Conf(args)
+    val protocol =
+      if (conf.imaps()) Imap.Protocol.imaps else Imap.Protocol.imap;
+    main(
+      protocol,
+      conf.host(),
+      conf.port(),
+      conf.username(),
+      conf.password(),
+      conf.folder(),
+      conf.expunge())
+  }
+
+  private def main(
+        protocol: Imap.Protocol.Value,
+        host: String, port: Int,
+        username: String, password: String,
+        folder: String,
+        expunge: Boolean): Unit = {
+    println("Please be patient.")
+    val session = Session.getDefaultInstance(System.getProperties, null)
+    for (store <- managed(Imap.getStore(session, protocol))) {
+      store.connect(host, port, username, password)
+      Reorder.byInternalDate(store, folder, expunge);
+    }
+    println("Done.")
+  }
+}
+
+private class Conf(arguments: Seq[String])
+    extends scallop.ScallopConf(arguments) {
+  banner(
+    """
+      |Reorders the messages in an IMAP folder so that sorting them by
+      |UID also sorts them by received date.  Works by copying the
+      |messages into the correct order, then deleting the unordered
+      |originals.
+    """.trim.stripMargin.replace('\n', ' ') + "\n" +
+
+    "\n" +
+
+    """
+      |Usage: imapreorder --host HOST --username USER --password PASS
+      |--folder FOLDER [OPTIONS]
+    """.trim.stripMargin.replace('\n', ' ') + "\n" +
+
+    """
+      |Options:
+    """.trim.stripMargin.replace('\n', ' '))
+
+  version(
+    """imapreorder 1.0.0
+      |Copyright © 2014 Iain Nicol""".stripMargin)
+
+  val imaps = opt[Boolean](
+    argName = "imaps",
+    descr = "Use IMAPS (port 993)",
+    noshort = true)
+  val host = opt[String](
+    argName = "host",
+    required = true,
+    descr = "Host; required")
+  val port = opt[Int](
+    argName = "port",
+    descr = "Port",
+    noshort = true)
+  val username = opt[String](
+    argName = "username",
+    required = true,
+    descr = "Username; required")
+  val password = opt[String](
+    argName = "password",
+    required = true,
+    descr = "Password; required")
+  val folder = opt[String](
+    argName = "folder",
+    required = true,
+    descr = "Email folder; required")
+  val expunge = opt[Boolean](
+    argName = "expunge",
+    descr = "Expunge unordered messages upon success, instead of simply " +
+      "setting the deleted flag",
+    noshort = true)
+}
diff --git a/src/main/scala/com/iainnicol/imapreorder/Reorder.scala b/src/main/scala/com/iainnicol/imapreorder/Reorder.scala
new file mode 100644 (file)
index 0000000..c7b4a60
--- /dev/null
@@ -0,0 +1,150 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package com.iainnicol.imapreorder
+
+import com.sun.mail.imap.{IMAPMessage, IMAPFolder, IMAPStore}
+import javax.mail.Folder
+import scala.collection.immutable.Seq
+import scala.collection.mutable.ListBuffer
+import scala.reflect.ClassTag
+
+/** Main program logic.
+ */
+object Reorder {
+
+  /** Changes the UIDs of some of the messages in the folder.  Afterwards,
+    * if sorting all of the folder's messages increasing by UID, the
+    * messages will also be weakly monotonically increasing by
+    * INTERNALDATE.
+    *
+    * The change is made by copying messages to and from a temporary
+    * folder.  It is designed to work safely.  If interrupted, the worst
+    * that can happen is that duplicate messages end up in the folder,
+    * or the temporary folder may not be removed.
+    *
+    * Upon success, deletes the now-copied messages.
+    *
+    * @param store an open store.
+    * @param expunge whether to expunge the folder upon success.
+    */
+  def byInternalDate(
+    store: IMAPStore,
+    folderName: String,
+    expunge: Boolean): Unit =
+  {
+    for (
+      origFolder <- Imap.getFolder(store, folderName, Folder.READ_WRITE);
+      tmpFolder <- Tmp.ImapFolder(origFolder))
+    {
+      var origMsgsAllUnsorted: Seq[IMAPMessage] = Imap.getMessages(origFolder)
+      origMsgsAllUnsorted = chunkApplyAndCombine(
+        origMsgsAllUnsorted,
+        ((msgsChunk: Iterable[IMAPMessage]) =>
+          Imap.fetchMetadata(msgsChunk, origFolder)))
+      val origMsgsToMove: Seq[IMAPMessage] =
+        getBadlyOrderedMsgs(origMsgsAllUnsorted, origFolder)
+
+      var tmpMsgs: Seq[IMAPMessage] = chunkApplyAndCombine(
+        origMsgsToMove,
+        ((msgsChunk: Iterable[IMAPMessage]) =>
+          Imap.copy(msgsChunk.toVector, origFolder, tmpFolder)))
+      tmpMsgs = chunkApplyAndCombine(
+         tmpMsgs,
+         ((msgsChunk: Iterable[IMAPMessage]) =>
+           Imap.fetchMetadata(msgsChunk, tmpFolder)))
+
+       val tmpMsgsSorted: Seq[IMAPMessage] =
+         tmpMsgs.sortBy(m => m.getReceivedDate()).toVector
+       chunkApplyAndCombine(
+         tmpMsgsSorted,
+         ((msgsChunk: Iterable[IMAPMessage]) =>
+           Imap.copy(msgsChunk.toVector, tmpFolder, origFolder)),
+         1)
+
+       chunkApplyAndCombine(
+         origMsgsToMove,
+         { (msgsChunk: Iterable[IMAPMessage]) =>
+           val msgsChunkVec: Seq[IMAPMessage] = msgsChunk.toVector
+           Imap.deleteMessages(origFolder, msgsChunkVec);
+           msgsChunkVec.map(_ => ()) })
+      if (expunge)
+        origFolder.expunge
+    }
+  }
+
+  /** Groups the iterable into chunks, applies an action to each chunk,
+    * then combines the results.
+    *
+    * Chunking is useful because, for example, IMAP servers tend to have
+    * a limit to the number of messages supported by individual IMAP
+    * requests.  At the same time, chunking multiple messages into one
+    * request performs better than individual requests for each message.
+    */
+  private def chunkApplyAndCombine[T, U: ClassTag](
+    iter: Iterable[T],
+    actionOnChunk: Iterable[T] => Iterable[U],
+    chunkSize: Int = 1000
+  ): Seq[U] = {
+    val chunks: Iterator[Iterable[T]] = iter.grouped(chunkSize)
+    val combined: ListBuffer[U] = ListBuffer()
+    for (chunk <- chunks) {
+      combined ++= actionOnChunk(chunk)
+    }
+    combined.toVector
+  }
+
+  /** Returns the messages in the folder which need reordered.
+    *
+    * A message needs reordered if its sort order by increasing UID
+    * disagrees with the sort order by increasing INTERNALDATE.
+    *
+    * All successive messages after a message needing reordered will
+    * also need reordered.  The reason why is we can increase the UID of
+    * the first badly ordered message by copying the message to a
+    * temporary folder then back into the folder.  The copy will then
+    * have a UID higher than all other messages in the folder.  This
+    * causes the messages in between the original and the copy of the
+    * first badly ordered message to be out of order.
+    *
+    * @param messages all of the messages in the folder.
+    */
+  private def getBadlyOrderedMsgs(
+    messages: Seq[IMAPMessage],
+    folder: IMAPFolder): Seq[IMAPMessage] = {
+    val sortedIncrementing: Seq[IMAPMessage] =
+      messages.sortBy(_.getReceivedDate)
+    if (sortedIncrementing.length <= 1)
+      return Seq()
+
+    val badlyOrderedPairs: Iterator[Seq[IMAPMessage]] =
+      sortedIncrementing.sliding(2).dropWhile(successiveMessages =>
+        (
+          folder.getUID(successiveMessages(0)) <
+            folder.getUID(successiveMessages(1))
+        )
+        ||
+        (
+          successiveMessages(0).getReceivedDate ==
+            successiveMessages(1).getReceivedDate)
+        )
+    val badlyOrderedWithDupes: ListBuffer[IMAPMessage] = new ListBuffer()
+    for (pair <- badlyOrderedPairs)
+      badlyOrderedWithDupes ++= pair.toList
+    val badlyOrdered: Seq[IMAPMessage] =
+      badlyOrderedWithDupes.distinct.toVector
+    return badlyOrdered
+  }
+}
diff --git a/src/main/scala/com/iainnicol/imapreorder/Tmp.scala b/src/main/scala/com/iainnicol/imapreorder/Tmp.scala
new file mode 100644 (file)
index 0000000..d47e3a9
--- /dev/null
@@ -0,0 +1,61 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package com.iainnicol.imapreorder
+
+import com.sun.mail.imap.IMAPFolder
+import java.nio.file.{Files, Path}
+import java.util.UUID
+import javax.mail.Folder
+import org.apache.commons.io.FileUtils
+import resource.{ManagedResource, makeManagedResource}
+
+/** Functions for temporary resources.
+ */
+object Tmp {
+
+  /** A temporary directory resource, usable with the scala-arm library.
+    * Immediately creates the concrete temporary directory.  Upon
+    * release, deletes the concrete directory, ignoring errors.
+    */
+  def Dir(): ManagedResource[Path] = {
+    val path: Path = Files.createTempDirectory(null)
+    val resource = makeManagedResource(path)({ path =>
+      FileUtils.deleteQuietly(path.toFile)
+      () })(List())
+    resource
+  }
+
+  /** A temporary IMAP folder resource, usable with the scala-arm library.
+    * Immediately creates the concrete IMAP folder.  Upon release,
+    * closes and deletes the concrete IMAP folder.
+    *
+    * @param parent parent folder to the temporary folder.
+    */
+  def ImapFolder(parent: IMAPFolder): ManagedResource[IMAPFolder] = {
+    val uuid: UUID = UUID.randomUUID
+    val folderName: String = s"imapreorder-tmp-$uuid"
+    val folder: IMAPFolder =
+      parent.getFolder(folderName).asInstanceOf[IMAPFolder]
+    val isCreated: Boolean = folder.create(Folder.HOLDS_MESSAGES)
+    if (!isCreated)
+      throw new Exception("Unable to create temporary IMAP folder.")
+    folder.open(Folder.READ_WRITE)
+    val resource = makeManagedResource(folder)({ folder =>
+      folder.close(false /* Expunge flag */)
+      folder.delete(true /* Recurse flag */) })(List())
+    resource
+  }
+}
diff --git a/src/test/scala/ReorderTest.scala b/src/test/scala/ReorderTest.scala
new file mode 100644 (file)
index 0000000..a03731e
--- /dev/null
@@ -0,0 +1,265 @@
+// Copyright © 2014 Iain Nicol
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import com.github.nscala_time.time.Imports
+import com.iainnicol.imapreorder._
+
+import com.github.nscala_time.time.Imports._
+import com.sun.mail.imap.{IMAPFolder, IMAPStore, IMAPMessage}
+import com.sun.security.auth.module.UnixSystem
+import java.io.{File, FileWriter}
+import java.nio.file.{Files, Path}
+import java.util.UUID
+import javax.mail.internet.{InternetAddress, MimeMessage}
+import javax.mail.{Folder, Message, Session}
+import org.apache.commons.io.FileUtils
+import org.scalacheck.{Gen, Properties}
+import org.scalacheck.Prop.forAll
+import resource.managed
+import scala.collection.immutable.Seq
+import scala.sys.process.{Process, ProcessBuilder}
+
+object ReorderTest extends Properties("Reorder") {
+
+  private var initialized = false
+  // Must be the first property in the object.
+  property("setup") = forAll { a: Int =>
+    if (!initialized)
+      setup()
+    initialized = true
+    true
+  }
+
+  private val datetimes = List(
+    new DateTime("2008-04-27T10:35:39"),
+    new DateTime("2009-08-21T12:55:28"),
+    new DateTime("2009-08-21T12:55:29"),
+    new DateTime("2013-01-16T01:02:02"),
+    new DateTime("2014-01-20T22:32:21"))
+  private val genReceivedDate: Gen[List[DateTime]] =
+    Gen.listOf(Gen.oneOf(datetimes))
+
+  property("reordersImapFolder") = forAll(genReceivedDate) { receivedDates =>
+    print(".") // Show progress because we're slow.
+
+    var result: Boolean = false
+    for (inbox <- Imap.getFolder(store, "Inbox", Folder.READ_WRITE)) {
+      val folderToReorderName: String = UUID.randomUUID.toString
+      val folderToReorder: IMAPFolder =
+        inbox.getFolder(folderToReorderName).asInstanceOf[IMAPFolder]
+      folderToReorder.create(Folder.HOLDS_MESSAGES)
+      folderToReorder.open(Folder.READ_WRITE)
+
+      folderToReorder.appendMessages(
+        receivedDates.map(getDummyMessage(_, session)).toArray)
+      val msgsBefore: Seq[IMAPMessage] =
+        Imap.getMessages(folderToReorder).sortBy(folderToReorder.getUID(_))
+      msgsBefore.zip(receivedDates).foreach({ x =>
+        assert(new DateTime(x._1.getReceivedDate) == x._2) })
+
+      Reorder.byInternalDate(
+        store,
+        folderToReorder.getFullName,
+        true /* Expunge flag */)
+
+      // Need to reopen the folder, because the underlying javamail API
+      // is lame.  Otherwise we see previously-expunged messages, and
+      // stale or invalid UIDs, when we getMessages.
+      folderToReorder.close(false /* Expunge flag */)
+      val folderToReorder2: IMAPFolder =
+        inbox.getFolder(folderToReorderName).asInstanceOf[IMAPFolder]
+      folderToReorder2.open(Folder.READ_WRITE)
+
+      val msgsAfter: Seq[IMAPMessage] =
+        Imap.getMessages(folderToReorder2).sortBy(folderToReorder2.getUID(_))
+      result = isCorrectlyReordered(msgsBefore, msgsAfter)
+
+      folderToReorder2.close(false /* Expunge flag */)
+      folderToReorder2.delete(true /* Recurse flag */)
+    }
+    result
+   }
+
+  // Must be the last property in the object.
+  property("cleanup") = forAll { a: Int =>
+    if (initialized)
+      cleanup()
+    initialized = false
+    true
+  }
+
+  /**
+   * @param before assumed to be sorted incrementing by UID.
+   * @param after ditto.
+   */
+  private def isCorrectlyReordered(
+    before: Seq[IMAPMessage],
+    after: Seq[IMAPMessage]): Boolean = {
+    val areSameLength: Boolean = (before.length == after.length)
+
+    val isIncrementingByReceivedDate: Boolean =
+      after.sliding(2).filter(_.size == 2)
+        .map(consecutiveMsgs => (consecutiveMsgs(0), consecutiveMsgs(1)))
+        .map{case (m1, m2) =>
+          (new DateTime(m1.getReceivedDate), new DateTime(m2.getReceivedDate))}
+        .forall{case (d1, d2) => d1 <= d2}
+
+    val areSameReceivedDates: Boolean =
+      (before.map(_.getReceivedDate).sorted ==
+        after.map(_.getReceivedDate).sorted)
+
+    // TODO: Ideally we'd check whether each message, as identified by
+    // its (unique) content, exists both before and after, and with the
+    // same receivedDate.
+
+    val result: Boolean = (
+      areSameLength
+        && isIncrementingByReceivedDate
+        && areSameReceivedDates)
+    result
+  }
+
+  private def getDummyMessage(date: DateTime, session: Session): Message = {
+    val message: Message = new MimeMessage(session)
+
+    // Can't set received date of a MimeMessage.  But if it's appended
+    // to an IMAP Folder the received date will default to the sent
+    // date.
+    message.setSentDate(date.toDate)
+
+    message.setFrom(new InternetAddress("sender@example.org"))
+    message.setRecipient(
+      Message.RecipientType.TO,
+      new InternetAddress("recipient@example.org"))
+    message.setSubject("TEST MESSAGE")
+
+    message.setText("MESSAGE")
+
+    message
+  }
+
+  var root: Path = null
+  var session: Session = null
+  var store: IMAPStore = null
+  var imapServerProcess: Process = null
+
+  private def setup(): Unit = {
+    val port: Int = 10143
+    val username: String = "imapreordertest"
+    val password: String = UUID.randomUUID.toString
+
+    root = Files.createTempDirectory(null)
+    val dovecotConf: Path = configureDovecot(root, port, username, password)
+    val imapServerProcessBuilder: ProcessBuilder = Process(
+      "dovecot",
+      List("-F", "-c", dovecotConf.toString))
+
+    imapServerProcess = imapServerProcessBuilder.run()
+    // This is ugly, but Dovecot won't be immediately available to connect to.
+    Thread.sleep(5000)
+
+    session = Session.getDefaultInstance(System.getProperties, null)
+    store = Imap.getStore(session, Imap.Protocol.imap)
+    store.connect("localhost", port, username, password)
+  }
+
+  private def cleanup(): Unit = {
+    store.close()
+    store = null
+    session = null
+
+    imapServerProcess.destroy()
+    imapServerProcess = null
+
+    FileUtils.deleteQuietly(root.toFile)
+    root = null
+  }
+
+  private def configureDovecot(
+    root: Path,
+    port: Int,
+    loginUsername: String,
+    loginPassword: String): Path = {
+    val etcDovecot: Path = root.resolve("etc/dovecot")
+    val dovecotConf: Path = etcDovecot.resolve("dovecot.conf")
+    val etcPasswd: Path = root.resolve("etc/passwd")
+
+    etcDovecot.toFile.mkdirs()
+
+    for (etcPasswdWriter <- managed(new FileWriter(etcPasswd.toFile))) {
+      val etcPasswdContents: String = s"$loginUsername:{PLAIN}$loginPassword\n"
+      etcPasswdWriter.write(etcPasswdContents)
+    }
+
+    for (dovecotConfWriter <- managed(new FileWriter(dovecotConf.toFile))) {
+      val userInfo = new UnixSystem()
+      val config: String = getDovecotDotConfContents(
+        root,
+        etcPasswd,
+        port,
+        userInfo.getUsername,
+        userInfo.getUid,
+        userInfo.getGid)
+      dovecotConfWriter.write(config)
+    }
+    dovecotConf
+  }
+
+  private def getDovecotDotConfContents(
+                root: Path, etcPasswd: Path,
+                port: Int,
+                filesystemUsername: String,
+                filesystemUid: Long, filesystemGid: Long): String = {
+    val homeDir: Path = root.resolve("home/%u").toAbsolutePath
+    val config: String = s"""
+        |protocols = imap
+        |listen = localhost
+        |base_dir = ${root.resolve("run/dovecot").toAbsolutePath}
+        |instance_name = dovecot-test
+        |
+        |log_path = /dev/null
+        |
+        |ssl = no
+        |
+        |mail_location = maildir:~/Maildir
+        |
+        |default_internal_user = $filesystemUsername
+        |default_login_user = $filesystemUsername
+        |
+        |service anvil {
+        |  chroot =
+        |}
+        |
+        |service imap-login {
+        |  chroot =
+        |    inet_listener imap {
+        |      port = $port
+        |    }
+        |}
+        |
+        |userdb {
+        |  args = uid=$filesystemUid gid=$filesystemGid home=$homeDir
+        |  driver = static
+        |}
+        |
+        |passdb {
+        |  args = ${etcPasswd.toAbsolutePath}
+        |  driver = passwd-file
+        |}
+        |"""
+
+      config.stripMargin
+  }
+}