Logo Search packages:      
Sourcecode: kmess version File versions

likebackdialog.cpp

#include <QHttp>
#include <QHttpRequestHeader>

#include <KAboutData>
#include <KApplication>
#include <KDebug>
#include <KMessageBox>
#include <KPushButton>

#include "likebackdialog.h"
#include "../kmessconfig.h"
#include "../../account.h"
#include "../../kmessdebug.h"



// Constructor
LikeBackDialog::LikeBackDialog( LikeBack::Button reason, const QString &initialComment,
                                const QString &windowPath, const QString &context, LikeBack *likeBack )
: KDialog( kapp->activeWindow() )
, Ui::LikeBackDialog()
, m_context( context )
, m_likeBack( likeBack )
, m_windowPath( windowPath )
{
  // KDialog Options
  setCaption( i18n( "Send a Comment to the Developers" ) );
  setButtons( Ok | Cancel );
  setDefaultButton( Ok );
  setObjectName( "LikeBackFeedBack" );
  showButtonSeparator( true );
  restoreDialogSize( KMessConfig::instance()->getGlobalConfig( "LikeBackDialog" ) );

  // Set up the user interface
  QWidget *mainWidget = new QWidget( this );
  setupUi( mainWidget );
  setMainWidget( mainWidget );

  // Group the buttons together to retrieve the checked one quickly
  m_typeGroup_ = new QButtonGroup( this );
  m_typeGroup_->addButton( likeRadio_,    LikeBack::Like    );
  m_typeGroup_->addButton( dislikeRadio_, LikeBack::Dislike );
  m_typeGroup_->addButton( bugRadio_,     LikeBack::Bug     );
  m_typeGroup_->addButton( featureRadio_, LikeBack::Feature );

  // Hide unneeded buttons
  LikeBack::Button buttons = m_likeBack->buttons();
  likeRadio_   ->setVisible( buttons & LikeBack::Like    );
  dislikeRadio_->setVisible( buttons & LikeBack::Dislike );
  bugRadio_    ->setVisible( buttons & LikeBack::Bug     );
  featureRadio_->setVisible( buttons & LikeBack::Feature );

  // If no specific "reason" is provided, choose the first one:
  if( reason == LikeBack::AllButtons || reason == LikeBack::DefaultButtons )
  {
         if( buttons & LikeBack::Dislike ) reason = LikeBack::Dislike;
    else if( buttons & LikeBack::Bug     ) reason = LikeBack::Bug;
    else if( buttons & LikeBack::Feature ) reason = LikeBack::Feature;
    else                                   reason = LikeBack::Like;
  }
  // Choose which button to check
  switch( reason )
  {
    case LikeBack::Like:    likeRadio_   ->setChecked( true ); break;
    case LikeBack::Dislike: dislikeRadio_->setChecked( true ); break;
    case LikeBack::Bug:     bugRadio_    ->setChecked( true ); break;
    case LikeBack::Feature: featureRadio_->setChecked( true ); break;
    default: break; // Will never arrive here
  }

   // Disable the Ok button if no comment is present
   connect( m_comment, SIGNAL( textChanged() ),
            this,      SLOT  (      verify() ) );

  // If no window path is provided, get the current active window path:
  if( m_windowPath.isEmpty() )
  {
    m_windowPath = LikeBack::activeWindowPath();
  }

  // Specify the initial comment
  m_comment->setPlainText( initialComment );
  m_comment->setFocus();

  // Set the Show Bar checkbox status and connect it
  showBarCheckbox_->setChecked( m_likeBack->userWantsToShowBar() );
  connect( showBarCheckbox_, SIGNAL(               toggled(bool) ),
           m_likeBack,       SLOT  ( setUserWantsToShowBar(bool) ) );

  // Provide the initial status for email address widgets if available
  emailAddressEdit_->setText( m_likeBack->emailAddress() );
  specifyEmailCheckBox_->setChecked( m_likeBack->emailAddressAlreadyProvided() );

  // The introduction message is long and will require a new minimum dialog size
  m_informationLabel->setText( introductionText() );
  setMinimumSize( minimumSizeHint() );

  // Initially verify the widgets status
  verify();
}



// Destructor
LikeBackDialog::~LikeBackDialog()
{
  KConfigGroup group = KMessConfig::instance()->getGlobalConfig( "LikeBackDialog" );
  saveDialogSize( group );
}



// Construct the introductory text of the dialog
QString LikeBackDialog::introductionText()
{
  QStringList acceptedLocales;
  KLocale *kLocale = KGlobal::locale();
  QStringList acceptedLocaleCodes = m_likeBack->acceptedLocales();

  // Define a list of languages which the application developers are able to understand
  if( ! acceptedLocaleCodes.isEmpty() )
  {
    foreach( const QString &locale, acceptedLocaleCodes )
    {
      acceptedLocales << kLocale->languageCodeToName( locale );
    }
  }
  else if( ! kLocale->language().startsWith( "en" ) )
  {
    acceptedLocales << kLocale->languageCodeToName( "en" );
  }

  // Put the locales list together in a readable string
  QString languagesMessage;
  if( ! acceptedLocales.isEmpty() )
  {
    // TODO: Replace the URL with a localized one:
    QString translationTool( "http://www.google.com/language_tools?hl=" + kLocale->language() );

    if( acceptedLocales.count() == 1 )
    {
      languagesMessage = i18nc( "Feedback dialog text, message with one accepted language for the comments",
                                "Please, write it in %1 (you may want to use an <a href=\"%3\">online translation tool</a> for this).<br/>",
                                acceptedLocales.first(),
                                translationTool );
    }
    else
    {
      languagesMessage = i18nc( "Feedback dialog text, message with list of accepted languages for the comments",
                                "Please, write it in %1 or %2 (you may want to use an <a href=\"%3\">online translation tool</a> for this).<br/>",
                                QStringList( acceptedLocales.mid( 1 ) ).join( ", " ),
                                acceptedLocales.first(),
                                translationTool );
    }
  }

  // If both "I Like" and "I Dislike" buttons are shown and one is clicked:
  QString balancingMessage;
  if( m_likeBack->isLikeActive() && m_likeBack->isDislikeActive()
  && ( m_typeGroup_->checkedId() == LikeBack::Like || m_typeGroup_->checkedId() == LikeBack::Dislike ) )
  {
    balancingMessage = i18nc( "Feedback dialog text, message to remind to balance the likes and dislikes",
                              "To make the comments you send more useful in improving this application, "
                              "try to send the same amount of positive and negative comments.<br/>" );
  }

  // If feature requests are not allowed:
  QString noFeatureRequestsMessage;
  if( ! m_likeBack->isFeatureActive() )
  {
    noFeatureRequestsMessage = i18nc( "Feedback dialog text, text to disallow feature requests",
                                      "Please, do not ask for new features: this kind of request will be ignored.<br/>" );
  }

  // Blend all previous messages together
  return i18nc( "Feedback dialog text, %1=Application name,%2=message with list of accepted languages for the comment,"
                "%3=optional text to remind to balance the likes and dislikes,%4=optional text to disallow feature requests.",
                "<p>You can provide to the developers a brief description of your opinions of %1.<br/>"
                "%2 " // %2: Contains the newline if present
                "%3%4</p>",
                m_likeBack->aboutData()->programName(),
                languagesMessage,
                balancingMessage,
                noFeatureRequestsMessage );
}



// Check if the UI should allow the user to send the comment
void LikeBackDialog::verify()
{
  bool hasComment = ( ! m_comment->document()->isEmpty() );
  bool hasType    = ( m_typeGroup_->checkedId() != -1 );

  button( Ok )->setEnabled( hasComment && hasType );
}



// Send the comment to the developers site (reimplemented from KDialog)
void LikeBackDialog::slotButtonClicked( int buttonId )
{
  // If the user has not pressed Ok, do nothing
  if( buttonId != Ok )
  {
    KDialog::slotButtonClicked( buttonId );
    return;
  }

  QString type;
  QString emailAddress;

  // Only send the email if the user wants it to be sent
  if( specifyEmailCheckBox_->isChecked() )
  {
    emailAddress = emailAddressEdit_->text();

    if( ! Account::isValidEmail( emailAddress ) )
    {
      KMessageBox::error( this, i18n( "The email address you have entered is not valid, and cannot be used: '%1'", emailAddress ) );
      return;
    }

    m_likeBack->setEmailAddress( emailAddress, true );
  }

  // Disable the UI while we're sending the request
  m_comment->setEnabled( false );
  button( Ok )->setEnabled( false );

  // Choose the type of feedback
  switch( m_typeGroup_->checkedId() )
  {
    case LikeBack::Like:    type = "Like";    break;
    case LikeBack::Dislike: type = "Dislike"; break;
    case LikeBack::Bug:     type = "Bug";     break;
    case LikeBack::Feature: type = "Feature"; break;
  }

  // Compile the feedback data
  QString data( "protocol=" + QUrl::toPercentEncoding( "1.0" )                              + '&' +
                "type="     + QUrl::toPercentEncoding( type )                               + '&' +
                "version="  + QUrl::toPercentEncoding( m_likeBack->aboutData()->version() ) + '&' +
                "locale="   + QUrl::toPercentEncoding( KGlobal::locale()->language() )      + '&' +
                "window="   + QUrl::toPercentEncoding( m_windowPath )                       + '&' +
                "context="  + QUrl::toPercentEncoding( m_context )                          + '&' +
                "comment="  + QUrl::toPercentEncoding( m_comment->toPlainText() )           + '&' +
                "email="    + QUrl::toPercentEncoding( emailAddress ) );


#ifdef KMESSDEBUG_LIKEBACK
  kDebug() << "http://" << m_likeBack->hostName() << ":" << m_likeBack->hostPort() << m_likeBack->remotePath();
  kDebug() << data;
#endif

  // Create the HTTP sending object and the actual request
  QHttp *http = new QHttp( m_likeBack->hostName(), m_likeBack->hostPort() );
  connect( http, SIGNAL( requestFinished(int,bool) ),
           this, SLOT  ( requestFinished(int,bool) ) );

  QHttpRequestHeader header( "POST", m_likeBack->remotePath() );
  header.setValue( "Host", m_likeBack->hostName() );
  header.setValue( "Content-Type", "application/x-www-form-urlencoded" );

  // Then send it at the developer site
  http->setHost( m_likeBack->hostName() );
  m_requestNumber_ = http->request( header, data.toUtf8() );
}



// Display confirmation of the sending action
void LikeBackDialog::requestFinished( int id, bool error )
{
  // Only analyze the request we've sent
  if( id != m_requestNumber_ )
  {
#ifdef KMESSDEBUG_LIKEBACK
  kDebug() << "Ignoring request" << id;
#endif
    return;
  }

#ifdef KMESSDEBUG_LIKEBACK
  kDebug() << "Request has" << (error?"failed":"succeeded");
#endif

  m_likeBack->disableBar();

  if( ! error )
  {
    KMessageBox::information( this,
                              i18nc( "Dialog box text",
                                     "<p>Your comment has been sent successfully."
                                     "It will help us improve the application!</p>"
                                     "<p>Thanks for your time.</p>" ),
                              i18nc( "Dialog box title", "Comment Sent" ) );

    hide();
    m_likeBack->enableBar();
    KDialog::accept();
    return;
  }

  // TODO: Save to file if error (connection not present at the moment)
  KMessageBox::error( this,
                      i18nc( "Dialog box text",
                              "<p>There has been an error while trying to send the report.</p>"
                              "<p>Please, try again later.</p>"),
                      i18nc( "Dialog box title", "Comment Sending Error" ) );

  m_likeBack->enableBar();

  // Re-enable the UI
  m_comment->setEnabled( true );
  verify();
}

#include "likebackdialog.moc"

Generated by  Doxygen 1.6.0   Back to index