src/frontends/qt/GuiLyXFiles.cpp

   1 /**
   2  * \file GuiLyXFiles.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Spitzmüller
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "GuiLyXFiles.h"
  14 #include "GuiApplication.h"
  15 #include "qt_helpers.h"
  16
  17 #include "FileDialog.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "FuncRequest.h"
  21 #include "Language.h"
  22 #include "LyXRC.h"
  23
  24 #include "support/environment.h"
  25 #include "support/filetools.h"
  26 #include "support/gettext.h"
  27 #include "support/lstrings.h"
  28 #include "support/Messages.h"
  29 #include "support/qstring_helpers.h"
  30 #include "support/Package.h"
  31
  32 #include <QDirIterator>
  33 #include <QTreeWidget>
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38 namespace lyx {
  39 namespace frontend {
  40
  41 namespace {
  42
  43 QString const guiString(QString in)
  44 {
  45         // recode specially encoded chars in file names (URL encoding and underbar)
  46         return QString::fromUtf8(QByteArray::fromPercentEncoding(in.toUtf8())).replace('_', ' ');
  47 }
  48
  49 } // namespace anon
  50
  51
  52 QMap<QString, QString> GuiLyXFiles::getFiles()
  53 {
  54         QMap<QString, QString> result;
  55         // We look for lyx files in the subdirectory dir of
  56         //   1) user_lyxdir
  57         //   2) build_lyxdir (if not empty)
  58         //   3) system_lyxdir
  59         // in this order. Files with a given sub-hierarchy will
  60         // only be listed once.
  61         // We also consider i18n subdirectories and store them separately.
  62         QStringList dirs;
  63         QStringList relpaths;
  64
  65         // The three locations to look at.
  66         string const user = addPath(package().user_support().absFileName(), fromqstr(type_));
  67         string const build = addPath(package().build_support().absFileName(), fromqstr(type_));
  68         string const system = addPath(package().system_support().absFileName(), fromqstr(type_));
  69
  70         available_languages_.insert(toqstr("en"), qt_("English"));
  71
  72         QString const type = fileTypeCO->itemData(fileTypeCO->currentIndex()).toString();
  73
  74         // Search in the base paths
  75         if (type == "all" || type == "user")
  76                 dirs << toqstr(user);
  77         if (type == "all" || type == "system")
  78                 dirs << toqstr(build)
  79                      << toqstr(system);
  80
  81         for (int i = 0; i < dirs.size(); ++i) {
  82                 QString const dir = dirs.at(i);
  83                 QDirIterator it(dir, QDir::Files, QDirIterator::Subdirectories);
  84                 while (it.hasNext()) {
  85                         QString fn(QFile(it.next()).fileName());
  86                         if (!fn.endsWith(getSuffix()))
  87                                 continue;
  88                         QString relpath = toqstr(makeRelPath(qstring_to_ucs4(fn),
  89                                                              qstring_to_ucs4(dir)));
  90                         // <cat>/
  91                         int s = relpath.indexOf('/', 0);
  92                         QString cat = qt_("General");
  93                         QString localization = "en";
  94                         if (s != -1) {
  95                                 // <cat>/<subcat>/
  96                                 cat = relpath.left(s);
  97                                 if (all_languages_.contains(cat)
  98                                     && !all_languages_.contains(dir.right(dir.lastIndexOf('/')))) {
  99                                         QMap<QString, QString>::const_iterator li = all_languages_.find(cat);
 100                                         // Skip i18n dir, but add language to the combo
 101                                         if (!available_languages_.contains(li.key()))
 102                                                 available_languages_.insert(li.key(), li.value());
 103                                         localization = cat;
 104                                         int sc = relpath.indexOf('/', s + 1);
 105                                         cat = (sc == -1) ? qt_("General") : relpath.mid(s + 1, sc - s - 1);
 106                                         s = sc;
 107                                 }
 108                                 if (s != -1) {
 109                                         int sc = relpath.indexOf('/', s + 1);
 110                                         QString const subcat = (sc == -1) ?
 111                                                                 QString() : relpath.mid(s + 1, sc - s - 1);
 112                                         if (!subcat.isEmpty())
 113                                                 cat += '/' + subcat;
 114                                 }
 115                         }
 116                         if (!relpaths.contains(relpath)) {
 117                                 relpaths.append(relpath);
 118                                 if (localization != "en")
 119                                         // strip off lang/
 120                                         relpath = relpath.mid(relpath.indexOf('/') + 1);
 121                                 result.insert(relpath, cat);
 122
 123                                 QMap<QString, QString> lm;
 124                                 if (localizations_.contains(relpath))
 125                                         lm = localizations_.find(relpath).value();
 126                                 lm.insert(localization, fn);
 127                                 localizations_.insert(relpath, lm);
 128                         }
 129                 }
 130         }
 131         // Find and store GUI language
 132         for (auto const & l : guilangs_) {
 133                 // First try with the full name
 134                 // `en' files are not in a subdirectory
 135                 if (available_languages_.contains(toqstr(l))) {
 136                         guilang_ = toqstr(l);
 137                         break;
 138                 }
 139                 // Then the name without country code
 140                 string const shortl = token(l, '_', 0);
 141                 if (available_languages_.contains(toqstr(shortl))) {
 142                         guilang_ = toqstr(shortl);
 143                         break;
 144                 }
 145         }
 146         // pre-fill the language combo (it will be updated once an item
 147         // has been clicked)
 148         languageCO->clear();
 149         QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
 150         while (i != available_languages_.constEnd()) {
 151                 languageCO->addItem(i.value(), i.key());
 152                 ++i;
 153         }
 154         setLanguage();
 155         languageLA->setText(qt_("Preferred &Language:"));
 156         return result;
 157 }
 158
 159
 160 GuiLyXFiles::GuiLyXFiles(GuiView & lv)
 161         : GuiDialog(lv, "lyxfiles", qt_("New File From Template"))
 162 {
 163         setupUi(this);
 164
 165         // Get all supported languages (by code) in order to exclude those
 166         // dirs later.
 167         QAbstractItemModel * language_model = guiApp->languageModel();
 168         language_model->sort(0);
 169         for (int i = 0; i != language_model->rowCount(); ++i) {
 170                 QModelIndex index = language_model->index(i, 0);
 171                 Language const * lang =
 172                         languages.getLanguage(fromqstr(index.data(Qt::UserRole).toString()));
 173                 if (!lang)
 174                         continue;
 175                 QString const code = toqstr(lang->code());
 176                 if (!all_languages_.contains(code))
 177                         all_languages_.insert(code, qt_(lang->display()));
 178                 // Also store code without country code
 179                 QString const shortcode = code.left(code.indexOf('_'));
 180                 if (shortcode != code && !all_languages_.contains(shortcode))
 181                         all_languages_.insert(shortcode, qt_(lang->display()));
 182         }
 183         // Get GUI language
 184         string lang = getGuiMessages().language();
 185         string const language = getEnv("LANGUAGE");
 186         if (!language.empty())
 187                 lang += ":" + language;
 188         guilangs_ =  getVectorFromString(lang, ":");
 189
 190         // The filter bar
 191         filter_ = new FancyLineEdit(this);
 192         filter_->setButtonPixmap(FancyLineEdit::Right, getPixmap("images/", "editclear", "svgz,png"));
 193         filter_->setButtonVisible(FancyLineEdit::Right, true);
 194         filter_->setButtonToolTip(FancyLineEdit::Right, qt_("Clear text"));
 195         filter_->setAutoHideButton(FancyLineEdit::Right, true);
 196         filter_->setPlaceholderText(qt_("All available files"));
 197         filter_->setToolTip(qt_("Enter string to filter the list of available files"));
 198 #if (QT_VERSION < 0x050000)
 199         connect(filter_, SIGNAL(downPressed()),
 200                 filesLW, SLOT(setFocus()));
 201 #else
 202         connect(filter_, &FancyLineEdit::downPressed,
 203                 filesLW, [=](){ focusAndHighlight(filesLW); });
 204 #endif
 205
 206         filterBarL->addWidget(filter_, 0);
 207         findKeysLA->setBuddy(filter_);
 208
 209         connect(buttonBox, SIGNAL(clicked(QAbstractButton *)),
 210                 this, SLOT(slotButtonBox(QAbstractButton *)));
 211
 212         connect(filesLW, SIGNAL(itemClicked(QTreeWidgetItem *, int)),
 213                 this, SLOT(fileSelectionChanged()));
 214         connect(filesLW, SIGNAL(itemSelectionChanged()),
 215                 this, SLOT(fileSelectionChanged()));
 216         connect(filter_, SIGNAL(textEdited(QString)),
 217                 this, SLOT(filterLabels()));
 218         connect(filter_, SIGNAL(rightButtonClicked()),
 219                 this, SLOT(resetFilter()));
 220
 221         bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
 222         bc().setOK(buttonBox->button(QDialogButtonBox::Open));
 223         bc().setCancel(buttonBox->button(QDialogButtonBox::Cancel));
 224
 225         //filesLW->setViewMode(QListView::ListMode);
 226         filesLW->setIconSize(QSize(22, 22));
 227
 228         QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
 229         QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
 230         fileTypeCO->addItem(qt_("User and System Files"), toqstr("all"));
 231         fileTypeCO->addItem(user_icon, qt_("User Files Only"), toqstr("user"));
 232         fileTypeCO->addItem(system_icon, qt_("System Files Only"), toqstr("system"));
 233
 234         setFocusProxy(filter_);
 235 }
 236
 237
 238 QString const GuiLyXFiles::getSuffix()
 239 {
 240         if (type_ == "bind" || type_ == "ui")
 241                 return toqstr(".") + type_;
 242         else if (type_ == "kbd")
 243                 return ".kmap";
 244
 245         return ".lyx";
 246 }
 247
 248
 249 bool GuiLyXFiles::translateName() const
 250 {
 251         return (type_ == "templates" || type_ == "examples");
 252 }
 253
 254
 255 void GuiLyXFiles::fileSelectionChanged()
 256 {
 257         if (!filesLW->currentItem()
 258             || !filesLW->currentItem()->data(0, Qt::UserRole).toString().endsWith(getSuffix())) {
 259                 // not a file (probably a header)
 260                 bc().setValid(false);
 261                 return;
 262         }
 263         changed();
 264 }
 265
 266
 267 void GuiLyXFiles::on_fileTypeCO_activated(int)
 268 {
 269         updateContents();
 270 }
 271
 272
 273 void GuiLyXFiles::on_languageCO_activated(int i)
 274 {
 275         savelang_ = languageCO->itemData(i).toString();
 276         if (!filesLW->currentItem())
 277                 return;
 278
 279         filesLW->currentItem()->setData(0, Qt::ToolTipRole, getRealPath());
 280         changed();
 281 }
 282
 283
 284 void GuiLyXFiles::on_filesLW_itemDoubleClicked(QTreeWidgetItem * item, int)
 285 {
 286         if (!item || !item->data(0, Qt::UserRole).toString().endsWith(getSuffix())) {
 287                 // not a file (probably a header)
 288                 bc().setValid(false);
 289                 return;
 290         }
 291
 292         applyView();
 293         dispatchParams();
 294         close();
 295 }
 296
 297 void GuiLyXFiles::on_filesLW_itemClicked(QTreeWidgetItem * item, int)
 298 {
 299         if (!item) {
 300                 bc().setValid(false);
 301                 return;
 302         }
 303
 304         QString const data = item->data(0, Qt::UserRole).toString();
 305         if (!data.endsWith(getSuffix())) {
 306                 // not a file (probably a header)
 307                 bc().setValid(false);
 308                 return;
 309         }
 310
 311         languageCO->clear();
 312         QMap<QString, QString>::const_iterator i =available_languages_.constBegin();
 313         while (i != available_languages_.constEnd()) {
 314                 if (localizations_.contains(data)
 315                     && localizations_.find(data).value().contains(i.key()))
 316                         languageCO->addItem(i.value(), i.key());
 317                 ++i;
 318         }
 319         languageLA->setText(qt_("File &Language:"));
 320         languageCO->setToolTip(qt_("All available languages of the selected file are displayed here.\n"
 321                                    "The selected language version will be opened."));
 322         setLanguage();
 323         QString const realpath = getRealPath();
 324         filesLW->currentItem()->setData(0, Qt::ToolTipRole, realpath);
 325         QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
 326         QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
 327         QIcon file_icon = (realpath.startsWith(toqstr(package().user_support().absFileName()))) ?
 328                         user_icon : system_icon;
 329         item->setIcon(0, file_icon);
 330 }
 331
 332
 333 void GuiLyXFiles::setLanguage()
 334 {
 335         // Enable language selection only if there is a selection.
 336         languageCO->setEnabled(languageCO->count() > 1);
 337         languageLA->setEnabled(languageCO->count() > 1);
 338         // first try last setting
 339         if (!savelang_.isEmpty()) {
 340                 int index = languageCO->findData(savelang_);
 341                 if (index != -1) {
 342                         languageCO->setCurrentIndex(index);
 343                         return;
 344                 }
 345         }
 346         // next, try GUI lang
 347         if (!guilang_.isEmpty()) {
 348                 int index = languageCO->findData(guilang_);
 349                 if (index != -1) {
 350                         languageCO->setCurrentIndex(index);
 351                         return;
 352                 }
 353         }
 354         // Finally, fall back to English (which should be always there)
 355         int index = languageCO->findData(toqstr("en"));
 356         if (index != -1) {
 357                 languageCO->setCurrentIndex(index);
 358         }
 359 }
 360
 361
 362 void GuiLyXFiles::on_browsePB_pressed()
 363 {
 364         QString path1 = toqstr(lyxrc.document_path);
 365         QString path2 = toqstr(lyxrc.example_path);
 366         QString title = qt_("Select example file");
 367         QString filter = qt_("LyX Documents (*.lyx)");
 368         QString b1 = qt_("D&ocuments");
 369         QString b2 = qt_("&Examples");
 370
 371         if (type_ == "templates") {
 372                 path2 = toqstr(lyxrc.template_path);
 373                 title = qt_("Select template file");
 374                 b1 = qt_("D&ocuments");
 375                 b2 = qt_("&Templates");
 376         }
 377         else if (type_ != "examples") {
 378                 path1 = toqstr(addName(package().user_support().absFileName(), fromqstr(type_)));
 379                 path2 = toqstr(addName(package().system_support().absFileName(), fromqstr(type_)));
 380                 b1 = qt_("&User files");
 381                 b2 = qt_("&System files");
 382         }
 383         if (type_ == "ui") {
 384                 title = qt_("Chose UI file");
 385                 filter = qt_("LyX UI Files (*.ui)");
 386         }
 387         if (type_ == "bind") {
 388                 title = qt_("Chose bind file");
 389                 filter = qt_("LyX Bind Files (*.bind)");
 390         }
 391         if (type_ == "kbd") {
 392                 title = qt_("Chose keyboard map");
 393                 filter = qt_("LyX Keymap Files (*.kmap)");
 394         }
 395
 396         FileDialog dlg(title);
 397         dlg.setButton1(b1, path1);
 398         dlg.setButton2(b2, path2);
 399
 400         FileDialog::Result result = dlg.open(path2, QStringList(filter));
 401
 402         if (result.first != FileDialog::Later && !result.second.isEmpty()) {
 403                 file_ = toqstr(FileName(fromqstr(result.second)).absFileName());
 404                 dispatchParams();
 405                 close();
 406         }
 407 }
 408
 409
 410 void GuiLyXFiles::updateContents()
 411 {
 412         languageCO->clear();
 413         QMap<QString, QString> files = getFiles();
 414         languageCO->model()->sort(0);
 415
 416         filesLW->clear();
 417         QIcon user_icon(getPixmap("images/", "lyxfiles-user", "svgz,png"));
 418         QIcon system_icon(getPixmap("images/", "lyxfiles-system", "svgz,png"));
 419         QStringList cats;
 420         QMap<QString, QString>::const_iterator it = files.constBegin();
 421         QFont capfont;
 422         capfont.setBold(true);
 423         while (it != files.constEnd()) {
 424                 QFileInfo const info = QFileInfo(it.key());
 425                 QString const realpath = getRealPath(it.key());
 426                 QString cat = it.value();
 427                 QString subcat;
 428                 QString catsave;
 429                 if (cat.contains('/')) {
 430                         catsave = cat;
 431                         cat = catsave.left(catsave.indexOf('/'));
 432                         subcat = toqstr(translateIfPossible(
 433                                         qstring_to_ucs4(guiString(catsave.mid(catsave.indexOf('/') + 1)))));
 434                 }
 435                 cat =  toqstr(translateIfPossible(qstring_to_ucs4(guiString(cat))));
 436                 QTreeWidgetItem * catItem;
 437                 if (!cats.contains(cat)) {
 438                         catItem = new QTreeWidgetItem();
 439                         catItem->setText(0, cat);
 440                         catItem->setFont(0, capfont);
 441                         filesLW->insertTopLevelItem(0, catItem);
 442                         catItem->setExpanded(true);
 443                         cats << cat;
 444                 } else
 445                         catItem = filesLW->findItems(cat, Qt::MatchExactly).first();
 446                 QTreeWidgetItem * item = new QTreeWidgetItem();
 447                 QString const filename = info.fileName();
 448                 QString guiname = filename.left(filename.lastIndexOf(getSuffix())).replace('_', ' ');
 449                 // Special case: defaults.lyx
 450                 if (type_ == "templates" && guiname == "defaults")
 451                         guiname = qt_("Default Template");
 452                 else if (translateName())
 453                         guiname = toqstr(translateIfPossible(qstring_to_ucs4(guiString(guiname))));
 454                 QIcon file_icon = (realpath.startsWith(toqstr(package().user_support().absFileName()))) ?
 455                                 user_icon : system_icon;
 456                 item->setIcon(0, file_icon);
 457                 item->setData(0, Qt::UserRole, it.key());
 458                 item->setData(0, Qt::DisplayRole, guiname);
 459                 item->setData(0, Qt::ToolTipRole, realpath);
 460                 if (subcat.isEmpty())
 461                         catItem->addChild(item);
 462                 else {
 463                         QTreeWidgetItem * subcatItem = nullptr;
 464                         if (cats.contains(catsave)) {
 465                                 QList<QTreeWidgetItem *> pcats = filesLW->findItems(cat, Qt::MatchExactly);
 466                                 for (int iit = 0; iit < pcats.size(); ++iit) {
 467                                         for (int cit = 0; cit < pcats.at(iit)->childCount(); ++cit) {
 468                                                 if (pcats.at(iit)->child(cit)->text(0) == subcat) {
 469                                                         subcatItem = pcats.at(iit)->child(cit);
 470                                                         break;
 471                                                 }
 472                                         }
 473                                 }
 474                         }
 475                         if (!subcatItem) {
 476                                 subcatItem = new QTreeWidgetItem();
 477                                 subcatItem->setText(0, subcat);
 478                                 subcatItem->setIcon(0, file_icon);
 479                                 cats << catsave;
 480                         }
 481                         subcatItem->addChild(item);
 482                         catItem->addChild(subcatItem);
 483                 }
 484                 ++it;
 485         }
 486         filesLW->sortItems(0, Qt::AscendingOrder);
 487         // redo filter
 488         filterLabels();
 489 }
 490
 491
 492 void GuiLyXFiles::slotButtonBox(QAbstractButton * button)
 493 {
 494         switch (buttonBox->standardButton(button)) {
 495         case QDialogButtonBox::Open:
 496                 slotOK();
 497                 break;
 498         case QDialogButtonBox::Cancel:
 499                 slotClose();
 500                 break;
 501         default:
 502                 break;
 503         }
 504 }
 505
 506
 507 void GuiLyXFiles::filterLabels()
 508 {
 509         Qt::CaseSensitivity cs = csFindCB->isChecked() ?
 510                 Qt::CaseSensitive : Qt::CaseInsensitive;
 511         QTreeWidgetItemIterator it(filesLW);
 512         while (*it) {
 513                 (*it)->setHidden(
 514                         (*it)->childCount() == 0
 515                         && !(*it)->text(0).contains(filter_->text(), cs)
 516                 );
 517                 ++it;
 518         }
 519 }
 520
 521
 522 void GuiLyXFiles::resetFilter()
 523 {
 524         filter_->setText(QString());
 525         filterLabels();
 526 }
 527
 528 QString const GuiLyXFiles::getRealPath(QString relpath)
 529 {
 530         if (relpath.isEmpty() && filesLW->currentItem() != nullptr)
 531                 relpath = filesLW->currentItem()->data(0, Qt::UserRole).toString();
 532         QString const language = languageCO->itemData(languageCO->currentIndex()).toString();
 533         if (localizations_.contains(relpath)) {
 534                 if (localizations_.find(relpath).value().contains(language))
 535                         return localizations_.find(relpath).value().find(language).value();
 536                 else if (localizations_.find(relpath).value().contains(guilang_))
 537                         return localizations_.find(relpath).value().find(guilang_).value();
 538                 else if (localizations_.find(relpath).value().contains(toqstr("en")))
 539                         return localizations_.find(relpath).value().find(toqstr("en")).value();
 540         }
 541         return QString();
 542 }
 543
 544
 545 void GuiLyXFiles::applyView()
 546 {
 547         file_ = getRealPath();
 548 }
 549
 550
 551 bool GuiLyXFiles::isValid()
 552 {
 553         return filesLW->currentItem() && filesLW->currentItem()->isSelected();
 554 }
 555
 556
 557 bool GuiLyXFiles::initialiseParams(string const & type)
 558 {
 559         type_ = type.empty() ? toqstr("templates") : toqstr(type);
 560         paramsToDialog();
 561         return true;
 562 }
 563
 564
 565 void GuiLyXFiles::passParams(string const & data)
 566 {
 567         initialiseParams(data);
 568         updateContents();
 569 }
 570
 571
 572 void GuiLyXFiles::selectItem(QString const item)
 573 {
 574         /* Using an intermediary variable flags is needed up to at least
 575          * Qt 5.5 because of a subtle namespace issue. See:
 576          *   https://stackoverflow.com/questions/10755058/qflags-enum-type-conversion-fails-all-of-a-sudden
 577          * for details.*/
 578         Qt::MatchFlags const flags(Qt::MatchExactly|Qt::MatchRecursive);
 579         QList<QTreeWidgetItem *> twi = filesLW->findItems(item, flags);
 580         if (!twi.isEmpty())
 581                 twi.first()->setSelected(true);
 582 }
 583
 584
 585 void GuiLyXFiles::paramsToDialog()
 586 {
 587         if (type_ == "examples")
 588                 setTitle(qt_("Open Example File"));
 589         else if (type_ == "templates")
 590                 setTitle(qt_("New File From Template"));
 591         else
 592                 setTitle(qt_("Open File"));
 593
 594         bc().setValid(isValid());
 595 }
 596
 597
 598 void GuiLyXFiles::dispatchParams()
 599 {
 600         if (file_.isEmpty())
 601                 return;
 602
 603         string arg;
 604         if (type_ == "templates")
 605                 arg = "newfile ";
 606         arg += fromqstr(file_);
 607         FuncCode const lfun = getLfun();
 608
 609         if (lfun == LFUN_NOACTION)
 610                 // emit signal
 611                 fileSelected(file_);
 612         else
 613                 dispatch(FuncRequest(lfun, arg));
 614 }
 615
 616
 617 FuncCode GuiLyXFiles::getLfun() const
 618 {
 619         if (type_ == "examples")
 620                 return LFUN_FILE_OPEN;
 621         else if (type_ == "templates")
 622                 return LFUN_BUFFER_NEW_TEMPLATE;
 623         return LFUN_NOACTION;
 624 }
 625
 626 Dialog * createGuiLyXFiles(GuiView & lv) { return new GuiLyXFiles(lv); }
 627
 628
 629 } // namespace frontend
 630 } // namespace lyx
 631
 632 #include "moc_GuiLyXFiles.cpp"