package votorola.a.web.wic.authen; // Copyright 2008-2009, 2012, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import org.apache.wicket.Page;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import votorola.a.web.wic.*;
import votorola.g.locale.*;
import votorola.g.lang.*;
import votorola.g.web.wic.*;


/** A link that logs the user in.
  */
public @ThreadRestricted("wicket") final class WC_LoginLink extends BookmarkablePageLinkX
{

    // OPT.  After moving to Wicket 1.5, login and logout links reconstruct some pages
    // twice: once for the state change and once again for the link click.  This is
    // because the pages are now stateless (to rid us of 1.5's new versioning parameters
    // in the URL) and so the links are no longer bookmarkable.


    /** Constructs a standard WC_LoginLink.
      *
      *     @param page the return page, which must be bookmarkable.
      */
    private WC_LoginLink( String _id, Page _page, final VRequestCycle cycle )
    {
        this( _id, _page, cycle.bunW().l( "a.web.wic.authen.WC_LoginLink.linkBody" ));
    }



    /** Constructs a WC_LoginLink with the specified body string.
      *
      *     @param page the return page, which must be bookmarkable.
      */
    public WC_LoginLink( String _id, final Page page, final String bodyString )
    {
        super( _id, VOWicket.get().authenticator().loginPageClass(), PageParametersX.withSet(
          new PageParameters(page.getPageParameters()), "returnClass", page.getClass().getName() ));
        assert page.isBookmarkable(): "return page must be bookmarkable";
        setBody( bodyString );
    }



    /** Constructs a standard WC_LoginLink or WC_LogoutLink depending on the user's
      * current login state.
      */
    public static BookmarkablePageLinkX newInOut( final String id, final Page page,
      final VRequestCycle cycle )
    {
        return VSession.get().user() == null? new WC_LoginLink(id,page,cycle):
          new WC_LogoutLink(id,page,cycle);
    }



}