chatline.cpp

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, 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 General Public License for more details.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
// Qt
#include <QApplication>
#include <QCheckBox>
#include <QCompleter>
#include <QGridLayout>
#include <QKeyEvent>
#include <QPainter>
#include <QScrollBar>
#include <QStyleFactory>
#include <QTextBlock>
#include <QTextLayout>
#include <QTextBrowser>
 
// common
#include "chat.h"
 
// client
#include "audio.h"
#include "climap.h"
#include "climisc.h"      // For write_chatline_content()
#include "connectdlg_common.h"
#include "control.h"
#include "game.h"
 
// gui-qt
#include "chatline.h"
#include "colors.h"
#include "fc_client.h"
#include "gui_main.h"
#include "qtg_cxxside.h"
 
static bool is_plain_public_message(QString s);
 
FC_CPP_DECLARE_LISTENER(chat_listener)
QStringList chat_listener::history = QStringList();
QStringList chat_listener::word_list = QStringList();
 
/***********************************************************************/
void chat_listener::update_word_list()
{
  QString str;
 
  conn_list_iterate(game.est_connections, pconn) {
    if (pconn->playing) {
      word_list << pconn->playing->name;
      word_list << pconn->playing->username;
    } else {
      word_list << pconn->username;
    }
  } conn_list_iterate_end;
 
  players_iterate(pplayer) {
    str = pplayer->name;
    if (!word_list.contains(str)) {
      word_list << str;
    }
  } players_iterate_end
 
  invoke(&chat_listener::chat_word_list_changed, word_list);
}
 
/***********************************************************************/
chat_listener::chat_listener() :
    position(HISTORY_END)
{}
 
/***********************************************************************/
void chat_listener::chat_message_received(const QString &,
                                          const struct text_tag_list *)
{}
 
/***********************************************************************/
void chat_listener::chat_word_list_changed(const QStringList &)
{}
 
/***********************************************************************/
void chat_listener::send_chat_message(const QString &message)
{
  int index;
  QString splayer, s;
 
  /* FIXME
   * Key == PICK: used for picking nation, it was put here cause those
   * Qt slots are a bit limited ...I'm unable to pass custom player pointer
   * or idk how to do that
   */
  s = message;
  index = message.indexOf("PICK:");
 
  if (index != -1) {
    s = s.remove("PICK:");
    // Now should be playername left in string
    players_iterate(pplayer) {
      splayer = QString(pplayer->name);
 
      if (!splayer.compare(s)) {
        popup_races_dialog(pplayer);
      }
    } players_iterate_end;
    return;
  }
 
  history << message;
  reset_history_position();
 
  // If client send commands to take ai, set /away to disable AI
  if (message.startsWith("/take ")) {
    s = s.remove("/take ");
    players_iterate(pplayer) {
      splayer = QString(pplayer->name);
      splayer = "\"" + splayer + "\"";
 
      if (!splayer.compare(s)) {
        if (is_ai(pplayer)) {
          send_chat(message.toUtf8());
          send_chat("/away");
          return;
        }
      }
    } players_iterate_end;
  }
 
  // Option to send to allies by default
  if (!message.isEmpty()) {
    if (client_state() >= C_S_RUNNING && gui_options.gui_qt_allied_chat_only
        && is_plain_public_message(message)) {
      send_chat((QString(CHAT_ALLIES_PREFIX)
                 + " " + message).toUtf8());
    } else {
      send_chat(message.toUtf8());
    }
  }
  // Empty messages aren't sent
  // FIXME Inconsistent behavior: "." will send an empty message to allies
}
 
/***********************************************************************/
QString chat_listener::back_in_history()
{
  if (!history.empty() && position == HISTORY_END) {
    position = history.size() - 1;
  } else if (position > 0) {
    position--;
  }
  return history.empty() ? "" : history.at(position);
}
 
/***********************************************************************/
QString chat_listener::forward_in_history()
{
  if (position == HISTORY_END) {
    return "";
  }
  position++;
  if (position >= history.size()) {
    position = HISTORY_END;
    return "";
  } else {
    return history.at(position);
  }
}
 
/***********************************************************************/
void chat_listener::reset_history_position()
{
  position = HISTORY_END;
}
 
/***********************************************************************/
chat_input::chat_input(QWidget *parent) :
    QLineEdit(parent)
{
  connect(this, &QLineEdit::returnPressed, this, &chat_input::send);
  chat_word_list_changed(current_word_list());
  chat_listener::listen();
}
 
/***********************************************************************/
void chat_input::send()
{
  send_chat_message(text());
  clear();
}
 
/***********************************************************************/
void chat_input::chat_word_list_changed(const QStringList &cmplt_word_list)
{
  QCompleter *cmplt = completer();
 
  if (cmplt != nullptr) {
    delete cmplt;
  }
 
  cmplt = new QCompleter(cmplt_word_list);
  cmplt->setCaseSensitivity(Qt::CaseInsensitive);
  cmplt->setCompletionMode(QCompleter::InlineCompletion);
  setCompleter(cmplt);
}
 
/***********************************************************************/
bool chat_input::event(QEvent *event)
{
  if (event->type() == QEvent::KeyPress) {
    QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
    switch (keyEvent->key()) {
    case Qt::Key_Up:
      setText(back_in_history());
      return true;
    case Qt::Key_Down:
      setText(forward_in_history());
      return true;
    }
  }
  return QLineEdit::event(event);
}
 
/***********************************************************************/
chatwdg::chatwdg(QWidget *parent)
{
  QGridLayout *gl;
 
  setParent(parent);
  cb = new QCheckBox("");
  cb->setToolTip(_("Allies only"));
  cb->setChecked(gui_options.gui_qt_allied_chat_only);
  gl = new QGridLayout;
  chat_line = new chat_input;
  chat_output = new text_browser_dblclck(this);
  chat_output->setFont(*fc_font::instance()->get_font(fonts::chatline));
  remove_links = new QPushButton("");
  remove_links->setIcon(style()->standardPixmap(QStyle::SP_DialogCancelButton));
  remove_links->setToolTip(_("Clear links"));
  gl->setVerticalSpacing(0);
  gl->addWidget(chat_output,0 , 0, 1 ,3);
  gl->addWidget(chat_line,1, 0);
  gl->addWidget(cb,1,1);
  gl->addWidget(remove_links,1,2);
  gl->setContentsMargins(0, 0, 6, 0);
  setLayout(gl);
  chat_output->setReadOnly(true);
  chat_line->installEventFilter(this);
  chat_output->setVisible(true);
  chat_output->setAcceptRichText(true);
  chat_output->setOpenLinks(false);
  chat_output->setReadOnly(true);
  connect(chat_output, &QTextBrowser::anchorClicked,
          this, &chatwdg::anchor_clicked);
  connect(chat_output, &QTextBrowser::anchorClicked,
          this, &chatwdg::anchor_clicked);
  connect(chat_output, &text_browser_dblclck::dbl_clicked,
          this, &chatwdg::toggle_size);
  connect(remove_links, &QAbstractButton::clicked, this, &chatwdg::rm_links);
#ifdef FC_QT6X_MODE
  // Qt-6.7
  connect(cb, &QCheckBox::checkStateChanged, this, &chatwdg::state_changed);
#else  // FC_QT6X_MODE
  connect(cb, &QCheckBox::stateChanged, this, &chatwdg::state_changed_depr);
#endif // FC_QT6X_MODE
  setMouseTracking(true);
 
  chat_listener::listen();
}
 
/***********************************************************************/
void chatwdg::state_changed(Qt::CheckState state)
{
  if (state != Qt::Unchecked) {
    gui_options.gui_qt_allied_chat_only = true;
  } else {
    gui_options.gui_qt_allied_chat_only = false;
  }
}
 
/***********************************************************************/
void chatwdg::state_changed_depr(int state)
{
  if (state > 0) {
    gui_options.gui_qt_allied_chat_only = true;
  } else {
    gui_options.gui_qt_allied_chat_only = false;
  }
}
 
/***********************************************************************/
void chatwdg::toggle_size()
{
  if (gui()->infotab->chat_maximized) {
    gui()->infotab->restore_chat();
    return;
  } else {
    gui()->infotab->maximize_chat();
    chat_line->setFocus();
  }
}
 
/***********************************************************************/
void chatwdg::scroll_to_bottom()
{
   chat_output->verticalScrollBar()->setSliderPosition(
                                 chat_output->verticalScrollBar()->maximum());
}
 
 
/***********************************************************************/
void chatwdg::update_font()
{
  QFont *qf;
  qf = fc_font::instance()->get_font(fonts::chatline);
  chat_output->setFont(*qf);
}
 
/***********************************************************************/
void chatwdg::rm_links()
{
  link_marks_clear_all();
}
 
/***********************************************************************/
void chatwdg::anchor_clicked(const QUrl &link)
{
  int n;
  QStringList sl;
  int id;
  enum text_link_type type;
  struct tile *ptile = nullptr;
 
  sl = link.toString().split(",");
  n = sl.at(0).toInt();
  id = sl.at(1).toInt();
 
  type = static_cast<text_link_type>(n);
 
  switch (type) {
  case TLT_CITY: {
    struct city *pcity = game_city_by_number(id);
 
    if (pcity) {
      ptile = client_city_tile(pcity);
    } else {
      output_window_append(ftc_client, _("This city isn't known!"));
    }
  }
  break;
  case TLT_TILE:
    ptile = index_to_tile(&(wld.map), id);
 
    if (!ptile) {
      output_window_append(ftc_client,
                           _("This tile doesn't exist in this game!"));
    }
    break;
  case TLT_UNIT: {
    struct unit *punit = game_unit_by_number(id);
 
    if (punit) {
      ptile = unit_tile(punit);
    } else {
      output_window_append(ftc_client, _("This unit isn't known!"));
    }
  }
  break;
  }
  if (ptile != nullptr) {
    center_tile_mapcanvas(ptile);
    link_mark_restore(type, id);
  }
}
 
/***********************************************************************/
void chatwdg::chat_message_received(const QString &message,
                                    const struct text_tag_list *tags)
{
  QColor col = chat_output->palette().color(QPalette::Text);
 
  append(apply_tags(message, tags, col));
}
 
/***********************************************************************/
void chatwdg::append(const QString &str)
{
  QTextCursor cursor;
 
  chat_output->append(str);
  chat_output->verticalScrollBar()->setSliderPosition(
                              chat_output->verticalScrollBar()->maximum());
}
 
/***********************************************************************/
void chatwdg::paint(QPainter *painter, QPaintEvent *event)
{
  painter->setBrush(QColor(0, 0, 0, 35));
  painter->drawRect(0, 0, width(), height());
}
 
/***********************************************************************/
void chatwdg::paintEvent(QPaintEvent *event)
{
  QPainter painter;
 
  painter.begin(this);
  paint(&painter, event);
  painter.end();
}
 
/***********************************************************************/
bool chatwdg::eventFilter(QObject *obj, QEvent *event)
{
  if (obj == chat_line) {
    if (event->type() == QEvent::KeyPress) {
      QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
 
      if (keyEvent->key() == Qt::Key_Escape) {
        gui()->infotab->restore_chat();
        gui()->mapview_wdg->setFocus();
        return true;
      }
    }
    if (event->type() == QEvent::ShortcutOverride) {
      event->setAccepted(true);
    }
  }
 
  return QObject::eventFilter(obj, event);
}
 
/***********************************************************************/
void chatwdg::update_widgets()
{
  if (is_server_running()) {
    cb->hide();
    remove_links->hide();
  } else {
    cb->show();
    remove_links->show();
  }
}
 
/***********************************************************************/
int chatwdg::default_size(int lines)
{
  int line_count = 0;
  int line_height;
  int size;
  QTextBlock qtb;
 
  qtb = chat_output->document()->firstBlock();
  /* Count all lines in all text blocks layouts
   * document()->lineCount returns number of lines without wordwrap */
 
  while (qtb.isValid()) {
    line_count = line_count + qtb.layout()->lineCount();
    qtb = qtb.next();
  }
 
  if (line_count == 0) {
    return 0;
  }
 
  line_height = (chat_output->document()->size().height()
                 - 2 * chat_output->document()->documentMargin())
                / line_count;
 
  size = lines * line_height
         + chat_line->size().height() + chat_output->document()->documentMargin();
  size = qMax(0, size);
 
  return size;
}
 
/***********************************************************************/
void chatwdg::make_link(struct tile *ptile)
{
  struct unit *punit;
  char buf[MAX_LEN_MSG];
 
  punit = find_visible_unit(ptile);
  if (tile_city(ptile)) {
    sz_strlcpy(buf, city_link(tile_city(ptile)));
  } else if (punit) {
    sz_strlcpy(buf, unit_link(punit));
  } else {
    sz_strlcpy(buf, tile_link(ptile));
  }
  chat_line->insert(QString(buf));
  chat_line->setFocus();
}
 
/***********************************************************************/
QString apply_tags(QString str, const struct text_tag_list *tags,
                   QColor bg_color)
{
  int start, stop, last_i;
  QString str_col;
  QString color;
  QString final_string;
  QByteArray qba;
  QColor qc;
  QMultiMap <int, QString> mm;
  QByteArray str_bytes;
 
  if (tags == nullptr) {
    return str;
  }
  str_bytes = str.toUtf8();
  qba = str_bytes.data();
 
  text_tag_list_iterate(tags, ptag) {
    if ((text_tag_stop_offset(ptag) == FT_OFFSET_UNSET)) {
      stop = qba.length();
    } else {
      stop = text_tag_stop_offset(ptag);
    }
 
    if ((text_tag_start_offset(ptag) == FT_OFFSET_UNSET)) {
      start = 0;
    } else {
      start = text_tag_start_offset(ptag);
    }
    switch (text_tag_type(ptag)) {
    case TTT_BOLD:
      mm.insert(stop, "</b>");
      mm.insert(start, "<b>");
      break;
    case TTT_ITALIC:
      mm.insert(stop, "</i>");
      mm.insert(start, "<i>");
      break;
    case TTT_STRIKE:
      mm.insert(stop, "</s>");
      mm.insert(start, "<s>");
      break;
    case TTT_UNDERLINE:
      mm.insert(stop, "</u>");
      mm.insert(start, "<u>");
      break;
    case TTT_COLOR:
      if (text_tag_color_foreground(ptag)) {
        color = text_tag_color_foreground(ptag);
          if (color == "#00008B") {
            color = bg_color.name();
          } else {
#ifdef FC_QT6X_MODE
            // Qt-6.4
            qc = QColor::fromString(color);
#else  // FC_QT6X_MODE
            qc.setNamedColor(color);
#endif // FC_QT6X_MODE
            qc = qc.lighter(200);
            color = qc.name();
          }
          str_col = QString("<span style=color:%1>").arg(color);
          mm.insert(stop, "</span>");
          mm.insert(start, str_col);
      }
      if (text_tag_color_background(ptag)) {
        color = text_tag_color_background(ptag);
        if (
#ifdef FC_QT6X_MODE
            // Qt-6.4
            QColor::isValidColorName(color)
#else  // FC_QT6X_MODE
            QColor::isValidColor(color)
#endif // FC_QT6X_MODE
            ) {
          str_col = QString("<span style= background-color:%1;>").arg(color);
          mm.insert(stop, "</span>");
          mm.insert(start, str_col);
        }
      }
      break;
    case TTT_LINK: {
      struct color *pcolor = nullptr;
 
      switch (text_tag_link_type(ptag)) {
      case TLT_CITY:
        pcolor = get_color(tileset, COLOR_MAPVIEW_CITY_LINK);
        break;
      case TLT_TILE:
        pcolor = get_color(tileset, COLOR_MAPVIEW_TILE_LINK);
        break;
      case TLT_UNIT:
        pcolor = get_color(tileset, COLOR_MAPVIEW_UNIT_LINK);
        break;
      }
 
      if (pcolor == nullptr) {
        break; // Not a valid link type case.
      }
      color = pcolor->qcolor.name(QColor::HexRgb);
      str_col = QString("<font color=\"%1\">").arg(color);
      mm.insert(stop, "</a></font>");
 
      color = QString(str_col + "<a href=%1,%2>").
              arg(QString::number(text_tag_link_type(ptag)),
                  QString::number(text_tag_link_id(ptag)));
      mm.insert(start, color);
    }
    }
  } text_tag_list_iterate_end;
 
  // Insert html starting from last items
  last_i = str.length();
  QMultiMap<int, QString>::const_iterator i = mm.constEnd();
  QMultiMap<int, QString>::const_iterator j = mm.constEnd();
 
  while (i != mm.constBegin()) {
    i--;
    if (i.key() < last_i) {
      final_string = final_string.prepend(QString(qba.mid(i.key(),
                                                          last_i - i.key()))
                                          .toHtmlEscaped());
    }
    last_i = i.key();
    j = i;
    if (i != mm.constBegin()) {
      j--;
    }
    if (j.key() == i.key() && i != j) {
      final_string = final_string.prepend(j.value());
      final_string = final_string.prepend(i.value());
      i--;
    } else {
      final_string = final_string.prepend(i.value());
    }
  }
 
  if (last_i == str.length()) {
    return str;
  }
 
  return final_string;
}
 
/***********************************************************************/
static bool is_plain_public_message(QString s)
{
  QString s1, str;
  int i;
 
  str = s.trimmed();
  if (str.at(0) == SERVER_COMMAND_PREFIX
      || str.at(0) == CHAT_ALLIES_PREFIX
      || str.at(0) == CHAT_DIRECT_PREFIX) {
    return false;
  }
 
  // Search for private message
  if (!str.contains(CHAT_DIRECT_PREFIX)) {
    return true;
  }
  i = str.indexOf(CHAT_DIRECT_PREFIX);
  str = str.left(i);
 
  // Compare all players and connections looking for match
  conn_list_iterate(game.all_connections, pconn) {
    s1 = pconn->username;
    if (s1.length() < i) {
      continue;
    }
    if (!QString::compare(s1.left(i), str, Qt::CaseInsensitive)) {
      return false;
    }
  } conn_list_iterate_end;
  players_iterate(pplayer) {
    s1 = pplayer->name;
    if (s1.length() < i) {
      continue;
    }
    if (!QString::compare(s1.left(i), str, Qt::CaseInsensitive)) {
      return false;
    }
  } players_iterate_end;
 
  return true;
}
 
/***********************************************************************/
void qtg_real_output_window_append(const char *astring,
                                   const struct text_tag_list *tags,
                                   int conn_id)
{
  QString str;
  QString wakeup;
  QApplication *qapp;
 
  str = QString::fromUtf8(astring);
  gui()->set_status_bar(str);
 
  wakeup = gui_options.gui_qt_wakeup_text;
 
  // Format wakeup string if needed
  if (wakeup.contains("%1")) {
    wakeup = wakeup.arg(client.conn.username);
  }
 
  qapp = current_app();
 
  if (str.contains(client.conn.username)) {
    qapp->alert(gui()->central_wdg);
  }
 
  // Play sound if we encountered wakeup string
  if (str.contains(wakeup) && client_state() < C_S_RUNNING
      && !wakeup.isEmpty()) {
    qapp->alert(gui()->central_wdg);
    audio_play_sound("e_player_wake", nullptr, nullptr);
  }
 
  chat_listener::update_word_list();
  chat_listener::invoke(&chat_listener::chat_message_received,
                        str, tags);
}
 
/***********************************************************************/
void log_output_window(void)
{
  // PORTME
  write_chatline_content(nullptr);
}
 
/***********************************************************************/
void clear_output_window(void)
{
  // PORTME
#if 0
  set_output_window_text(_("Cleared output window."));
#endif
}
 
/***********************************************************************/
version_message_event::version_message_event(const QString &msg) :
  QEvent(QEvent::User),
  message(msg)
{}
 
/***********************************************************************/
void qtg_version_message(const char *vertext)
{
  current_app()->postEvent(gui(), new version_message_event(vertext));
}