Permalink
Browse files

Initial commit

  • Loading branch information...
0 parents commit ae0918788d6fa8ae337045844aabd049bb24fbd4 @fcardinaux fcardinaux committed Sep 18, 2011
Showing with 416 additions and 0 deletions.
  1. +202 −0 LICENSE
  2. +54 −0 README
  3. +75 −0 mod_recaptcha.erl
  4. +61 −0 models/m_recaptcha.erl
  5. +24 −0 templates/_captcha.tpl
202 LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright 2011 François Cardinaux, CH 1207 Geneva (http://bit.ly/qTaona)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
54 README
@@ -0,0 +1,54 @@
+mod_recaptcha Readme File
+=========================
+
+Author: François Cardinaux, CH 1207 Geneva (http://bit.ly/qTaona)
+
+Overview of the current folder:
+ * The current folder is dedicated to the mod_recaptcha module for Zotonic
+ (http://www.zotonic.com)
+ * It contains all files that are necessary to this project
+ * There is no symlink of any sort to external resources
+
+Credits
+-------
+
+The following references have been helpful to write this module:
+ * the reCaptcha API: http://code.google.com/apis/recaptcha/
+ * How to make HTTP post:
+ http://erlangexamples.com/2009/02/24/how-to-make-http-post/
+ * recaptcha-erlang: http://code.google.com/p/recaptcha-erlang/
+
+Installation
+------------
+
+ 1. Copy this folder to /path/to/zotonic/modules/
+ 2. Start Zotonic
+ 3. Open your site with a web browser and log in as admin
+ 4. Enable the Recaptcha module: go "Modules", find the "Recaptcha" module and
+ click on "activate"
+ 5. Go to "System" and click on "rescan modules"
+ 6. Edit your signup form template (typically signup.tpl) and add the following
+ line where you want the captcha to appear:
+
+ {% include "_captcha.tpl" %}
+
+Configuration
+-------------
+
+ 1. Go to http://www.google.com/recaptcha and follow the instructions to create
+ your Recaptcha keys (one public key and one private key)
+
+ 2. Go to "Config" and click on "make a new config setting"
+
+ Module: mod_recaptcha
+ Key: public_key
+ Value: <your public key>
+
+ 6. Always in "Config", click on "make a new config setting" again
+
+ Module: mod_recaptcha
+ Key: private_key
+ Value: <your private key>
+
+
+
@@ -0,0 +1,75 @@
+%% @author François Cardinaux, CH 1207 Geneva (http://bit.ly/qTaona)
+%% and the owner of recaptcha-erlang (http://code.google.com/p/recaptcha-erlang/)
+%% @copyright 2011 François Cardinaux
+%% @date 2011-09-18
+%% @doc Recaptcha module
+
+%% @todo Implement the use of the Ajax API (http://code.google.com/apis/recaptcha/docs/display.html)
+
+-module(mod_recaptcha).
+-author("François Cardinaux <fcardinaux@gmail.com>").
+
+-mod_title("Recaptcha").
+-mod_description("Recaptcha module.").
+
+-export([observe_signup_check/3]).
+
+-include_lib("zotonic.hrl").
+
+observe_signup_check(signup_check, {ok, Props, SignupProps}, Context) ->
+ Challenge = z_context:get_q("recaptcha_challenge_field", Context),
+ Response = z_context:get_q("recaptcha_response_field", Context),
+
+ case check_recaptcha(Challenge, Response, Context) of
+ ok ->
+ {ok, Props, SignupProps};
+ {error, _} = Error ->
+ Error
+ end.
+
+check_recaptcha(Challenge, Response, Context) ->
+
+ RemoteIP = "127.0.0.1", %% @todo Replace this with the remote IP address
+
+ % Explanation:
+ % * http://erlangexamples.com/2009/02/24/how-to-make-http-post/
+ % * http://code.google.com/p/recaptcha-erlang/
+ inets:start(),
+ Data = string:join(
+ [
+ string:join(["privatekey", mochiweb_util:quote_plus(m_recaptcha:private_key(Context))], "="),
+ string:join(["remoteip", mochiweb_util:quote_plus(RemoteIP)], "="),
+ string:join(["challenge", mochiweb_util:quote_plus(Challenge)], "="),
+ string:join(["response", mochiweb_util:quote_plus(Response)], "=")
+ ], "&"),
+
+ HttpResponse =
+ httpc:request(
+ post,
+ {
+ get_recaptcha_verify_url(),
+ [],
+ "application/x-www-form-urlencoded",
+ Data
+ },
+ [], []),
+
+ case HttpResponse of
+ {ok, Result} ->
+ [FirstLine|NextLines] = case Result of
+ {_Status, _Headers, Body} -> string:tokens(Body, "\r\n");
+ {_Status, Body} -> string:tokens(Body, "\r\n")
+ end,
+ case FirstLine of
+ "true" ->
+ ok;
+ _ ->
+ {error, lists:flatten(NextLines)}
+ end;
+ {error, _} = Error ->
+ Error
+ end.
+
+get_recaptcha_verify_url() ->
+ "http://www.google.com/recaptcha/api/verify".
+
@@ -0,0 +1,61 @@
+%% @doc Recaptcha model
+%% @end
+%%
+%% @author François Cardinaux, CH 1207 Geneva (http://bit.ly/qTaona)
+%% @copyright 2011 François Cardinaux
+
+-module(m_recaptcha).
+-author("François Cardinaux <fcardinaux@gmail.com>").
+
+-behaviour(gen_model).
+
+%% interface functions
+-export([
+ % Callbacks for gen_model behaviour
+ m_find_value/3,
+ m_to_list/2,
+ m_value/2
+]).
+
+-export([private_key/1, public_key/1]).
+
+-include_lib("zotonic.hrl").
+
+%% @doc Fetch the value for the key from a model source
+%% @spec m_find_value(Key, Source, Context) -> term()
+m_find_value(public_key, #m{value=undefined}, Context) ->
+ public_key(Context);
+
+m_find_value(_Key, #m{value=undefined}, _Context) ->
+ undefined.
+
+%% @doc Transform a m_config value to a list, used for template loops
+%% @spec m_to_list(Source, Context)
+m_to_list(_, _Context) ->
+ [].
+
+%% @doc Transform a model value so that it can be formatted or piped through filters
+%% @spec m_value(Source, Context) -> term()
+m_value(#m{value=undefined}, _Context) ->
+ undefined.
+
+private_key(Context) ->
+ get_key(private_key, Context).
+
+public_key(Context) ->
+ get_key(public_key, Context).
+
+get_key(Type, Context) ->
+ Val = m_config:get_value(mod_recaptcha, Type, Context),
+
+ SVal = if
+ is_binary(Val) ->
+ binary_to_list(Val);
+ true ->
+ Val
+ end,
+
+ string:strip(SVal).
+
+
+
Oops, something went wrong.

0 comments on commit ae09187

Please sign in to comment.