sc/source/ui/collab/sendfunc.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include "sendfunc.hxx"
  11
  12 #include "formulacell.hxx"
  13 #include "docsh.hxx"
  14 #include "docfunc.hxx"
  15 #include "sccollaboration.hxx"
  16 #include <editeng/editeng.hxx>
  17 #include <editeng/editobj.hxx>
  18 #include <tubes/manager.hxx>
  19
  20 namespace {
  21
  22 OUString formulaCellToString( ScFormulaCell *pCell )
  23 {
  24     (void)pCell; // FIXME: implement me
  25     return OUString();
  26 }
  27
  28 OUString editToString( const EditTextObject& /*rEditText*/ )
  29 {
  30     // FIXME: implement me.
  31     return OUString();
  32 }
  33
  34 EditTextObject stringToEdit( const OUString& /* rStr */ )
  35 {
  36     // FIXME: implement me.
  37     // The code here only serves to make this file compilable.
  38     EditEngine aEditEngine(0);
  39     return *aEditEngine.CreateTextObject();
  40 }
  41
  42 ScFormulaCell* stringToFormulaCell( const OUString &rString )
  43 {
  44     (void)rString; // FIXME: implement me
  45     return NULL;
  46 }
  47
  48 struct ProtocolError {
  49     const char *message;
  50 };
  51
  52 class ScChangeOpReader {
  53     std::vector< OUString > maArgs;
  54
  55 public:
  56     ScChangeOpReader( const OUString &rString)
  57     {
  58         // will need to handle escaping etc.
  59         // Surely someone else wrote this before ! [!?]
  60         enum {
  61             IN_TEXT, CHECK_QUOTE, FIND_LAST_QUOTE, SKIP_SEMI
  62         } eState = CHECK_QUOTE;
  63
  64         sal_Int32 nStart = 0;
  65         for (sal_Int32 n = 0; n < rString.getLength(); n++)
  66         {
  67             if (rString[n] == '\\')
  68             {
  69                 n++; // skip next char
  70                 continue;
  71             }
  72             switch (eState) {
  73             case CHECK_QUOTE:
  74                 if (rString[n] == '"')
  75                 {
  76                     nStart = n + 1;
  77                     eState = FIND_LAST_QUOTE;
  78                     break;
  79                 }
  80                 // else drop through
  81             case IN_TEXT:
  82                 if (rString[n] == ';')
  83                 {
  84                     maArgs.push_back( rString.copy( nStart, n - nStart ) );
  85                     nStart = n + 1;
  86                     eState = CHECK_QUOTE;
  87                 }
  88                 break;
  89             case FIND_LAST_QUOTE:
  90                 if (rString[n] == '"')
  91                 {
  92                     maArgs.push_back( rString.copy( nStart, n - nStart ) );
  93                     eState = SKIP_SEMI;
  94                     break;
  95                 }
  96                 break;
  97             case SKIP_SEMI:
  98                 if (rString[n] == ';')
  99                 {
 100                     nStart = n + 1;
 101                     eState = CHECK_QUOTE;
 102                 }
 103                 break;
 104             }
 105         }
 106         if ( nStart < rString.getLength())
 107             maArgs.push_back( rString.copy( nStart, rString.getLength() - nStart ) );
 108     }
 109     ~ScChangeOpReader() {}
 110
 111     OUString getMethod()
 112     {
 113         return maArgs[0];
 114     }
 115
 116     size_t getArgCount() { return maArgs.size(); }
 117
 118     OUString getString( sal_Int32 n )
 119     {
 120         if (n > 0 && (size_t)n < getArgCount() )
 121         {
 122             OUString aUStr( maArgs[ n ] );
 123             ScGlobal::EraseQuotes( aUStr );
 124             return aUStr;
 125         } else
 126             return OUString();
 127     }
 128
 129     ScAddress getAddress( sal_Int32 n )
 130     {
 131         ScAddress aAddr;
 132         OUString aToken( getString( n ) );
 133         aAddr.Parse( aToken );
 134         return aAddr;
 135     }
 136
 137     sal_Int32 getInt( sal_Int32 n )
 138     {
 139         return getString( n ).toInt32();
 140     }
 141
 142     bool getBool( sal_Int32 n )
 143     {
 144         return getString( n ).equalsIgnoreAsciiCase( "true" );
 145     }
 146
 147     ScFormulaCell* getFormulaCell( sal_Int32 n )
 148     {
 149         return stringToFormulaCell( getString( n ) );
 150     }
 151
 152     double getDouble( sal_Int32 n )
 153     {
 154         return getString(n).toDouble();
 155     }
 156
 157     EditTextObject getEdit( sal_Int32 n )
 158     {
 159         return stringToEdit(getString(n));
 160     }
 161
 162 };
 163
 164 } // anonymous namespace
 165
 166 // Ye noddy mangling - needs improvement ...
 167 // method name ';' then arguments ; separated
 168 class ScChangeOpWriter
 169 {
 170     OUStringBuffer aMessage;
 171     void appendSeparator()
 172     {
 173         aMessage.append( ';' );
 174     }
 175
 176 public:
 177     ScChangeOpWriter( const char *pName )
 178     {
 179         aMessage.appendAscii( pName );
 180         appendSeparator();
 181     }
 182
 183     void appendString( const OUString &rStr )
 184     {
 185         if ( rStr.indexOf( '"' ) >= 0 ||
 186              rStr.indexOf( ';' ) >= 0 )
 187         {
 188             OUString aQuoted( rStr );
 189             ScGlobal::AddQuotes( aQuoted, '"' );
 190             aMessage.append( aQuoted );
 191         }
 192         else
 193             aMessage.append( rStr );
 194         appendSeparator();
 195     }
 196
 197     void appendAddress( const ScAddress &rPos )
 198     {
 199         aMessage.append( rPos.Format( SCA_VALID ) );
 200         appendSeparator();
 201     }
 202
 203     void appendInt( sal_Int32 i )
 204     {
 205         aMessage.append( i );
 206         appendSeparator();
 207     }
 208
 209     void appendBool( sal_Bool b )
 210     {
 211         aMessage.appendAscii( b ? "true" : "false" );
 212         appendSeparator();
 213     }
 214
 215     void appendFormulaCell( ScFormulaCell *pCell )
 216     {
 217         appendString( formulaCellToString( pCell ) );
 218     }
 219
 220     void appendEditText( const EditTextObject& rStr )
 221     {
 222         appendString( editToString(rStr) );
 223     }
 224
 225     void appendDouble( double fVal )
 226     {
 227         aMessage.append(fVal);
 228         appendSeparator();
 229     }
 230
 231     OString toString()
 232     {
 233         return OUStringToOString( aMessage.toString(), RTL_TEXTENCODING_UTF8 );
 234     }
 235 };
 236
 237 void ScDocFuncSend::RecvMessage( const OString &rString )
 238 {
 239     try {
 240         ScChangeOpReader aReader( OUString( rString.getStr(),
 241                                                  rString.getLength(),
 242                                                  RTL_TEXTENCODING_UTF8 ) );
 243         // FIXME: have some hash to enumeration mapping here
 244         if ( aReader.getMethod() == "setNormalString" )
 245         {
 246             bool bNumFmtSet = false;
 247             mpDirect->SetNormalString( bNumFmtSet, aReader.getAddress( 1 ), aReader.getString( 2 ),
 248                                       aReader.getBool( 3 ) );
 249         }
 250         else if (aReader.getMethod() == "setValueCell")
 251         {
 252             mpDirect->SetValueCell(
 253                 aReader.getAddress(1), aReader.getDouble(2), aReader.getBool(3));
 254         }
 255         else if (aReader.getMethod() == "setStringCell")
 256         {
 257             mpDirect->SetStringCell(
 258                 aReader.getAddress(1), aReader.getString(2), aReader.getBool(3));
 259         }
 260         else if (aReader.getMethod() == "setEditCell")
 261         {
 262             mpDirect->SetEditCell(
 263                 aReader.getAddress(1), aReader.getEdit(2), aReader.getBool(3));
 264         }
 265         else if (aReader.getMethod() == "setFormulaCell")
 266         {
 267             mpDirect->SetFormulaCell(
 268                 aReader.getAddress(1), aReader.getFormulaCell(2), aReader.getBool(3));
 269         }
 270         else if ( aReader.getMethod() == "enterListAction" )
 271             mpDirect->EnterListAction( aReader.getInt( 1 ) );
 272         else if ( aReader.getMethod() == "endListAction" )
 273             mpDirect->EndListAction();
 274         else if ( aReader.getMethod() == "showNote" )
 275             mpDirect->ShowNote( aReader.getAddress( 1 ), aReader.getBool( 2 ) );
 276         else if ( aReader.getMethod() == "setNoteText" )
 277             mpDirect->SetNoteText( aReader.getAddress( 1 ), aReader.getString( 2 ),
 278                                   aReader.getBool( 3 ) );
 279         else if ( aReader.getMethod() == "renameTable" )
 280             mpDirect->RenameTable( aReader.getInt( 1 ), aReader.getString( 2 ),
 281                                   aReader.getBool( 3 ), aReader.getBool( 4 ) );
 282         else
 283             SAL_WARN( "sc.tubes", "Error: unknown message '" << rString.getStr()
 284                     << "' (" << aReader.getArgCount() << ")" );
 285     } catch (const ProtocolError &e) {
 286         SAL_WARN( "sc.tubes", "Error: protocol twisting: " << e.message );
 287     }
 288 }
 289
 290 void ScDocFuncSend::SendMessage( ScChangeOpWriter &rOp )
 291 {
 292     mpCollaboration->SendPacket( rOp.toString() );
 293 }
 294
 295 // FIXME: really ScDocFunc should be an abstract base, so
 296 // we don't need the rDocSh hack/pointer
 297 ScDocFuncSend::ScDocFuncSend( ScDocShell& rDocSh, ScDocFuncDirect *pDirect, ScCollaboration* pCollaboration )
 298         : ScDocFunc( rDocSh ),
 299         mpDirect( pDirect ),
 300         mpCollaboration( pCollaboration )
 301 {
 302 }
 303
 304 ScDocFuncSend::~ScDocFuncSend()
 305 {
 306     delete mpDirect;
 307 }
 308
 309 void ScDocFuncSend::EnterListAction( sal_uInt16 nNameResId )
 310 {
 311     // Want to group these operations for the other side ...
 312     OUString aUndo( ScGlobal::GetRscString( nNameResId ) );
 313     ScChangeOpWriter aOp( "enterListAction" );
 314     aOp.appendInt( nNameResId ); // nasty but translate-able ...
 315     SendMessage( aOp );
 316 }
 317
 318 void ScDocFuncSend::EndListAction()
 319 {
 320     ScChangeOpWriter aOp( "endListAction" );
 321     SendMessage( aOp );
 322 }
 323
 324 sal_Bool ScDocFuncSend::SetNormalString( bool& o_rbNumFmtSet, const ScAddress& rPos, const OUString& rText, sal_Bool bApi )
 325 {
 326     ScChangeOpWriter aOp( "setNormalString" );
 327     aOp.appendAddress( rPos );
 328     aOp.appendString( rText );
 329     aOp.appendBool( bApi );
 330     SendMessage( aOp );
 331
 332     o_rbNumFmtSet = false;
 333
 334     if ( OUString( rText ) == "saveme" )
 335         mpCollaboration->SaveAndSendFile( NULL );
 336
 337     if ( OUString( rText ) == "contacts" )
 338         mpCollaboration->DisplayContacts();
 339
 340     return true; // needs some code auditing action
 341 }
 342
 343 bool ScDocFuncSend::SetValueCell( const ScAddress& rPos, double fVal, bool bInteraction )
 344 {
 345     ScChangeOpWriter aOp("setValueCell");
 346     aOp.appendAddress( rPos );
 347     aOp.appendDouble( fVal );
 348     aOp.appendBool( bInteraction );
 349     SendMessage( aOp );
 350     return true; // needs some code auditing action
 351 }
 352
 353 bool ScDocFuncSend::SetStringCell( const ScAddress& rPos, const OUString& rStr, bool bInteraction )
 354 {
 355     ScChangeOpWriter aOp("setStringCell");
 356     aOp.appendAddress( rPos );
 357     aOp.appendString( rStr );
 358     aOp.appendBool( bInteraction );
 359     SendMessage( aOp );
 360     return true; // needs some code auditing action
 361 }
 362
 363 bool ScDocFuncSend::SetEditCell( const ScAddress& rPos, const EditTextObject& rStr, bool bInteraction )
 364 {
 365     ScChangeOpWriter aOp("setEditCell");
 366     aOp.appendAddress( rPos );
 367     aOp.appendEditText( rStr );
 368     aOp.appendBool( bInteraction );
 369     SendMessage( aOp );
 370     return true; // needs some code auditing action
 371 }
 372
 373 bool ScDocFuncSend::SetFormulaCell( const ScAddress& rPos, ScFormulaCell* pCell, bool bInteraction )
 374 {
 375     ScChangeOpWriter aOp("setFormulaCell");
 376     aOp.appendAddress( rPos );
 377     aOp.appendFormulaCell( pCell );
 378     aOp.appendBool( bInteraction );
 379     SendMessage( aOp );
 380     delete pCell;
 381     return true; // needs some code auditing action
 382 }
 383
 384 bool ScDocFuncSend::PutData( const ScAddress& rPos, ScEditEngineDefaulter& rEngine, bool bApi )
 385 {
 386     SAL_INFO( "sc.tubes", "PutData not implemented!" );
 387     return ScDocFunc::PutData( rPos, rEngine, bApi );
 388 }
 389
 390 bool ScDocFuncSend::SetCellText(
 391     const ScAddress& rPos, const OUString& rText, bool bInterpret, bool bEnglish, bool bApi,
 392     const formula::FormulaGrammar::Grammar eGrammar )
 393 {
 394     SAL_INFO( "sc.tubes", "SetCellText not implemented!" );
 395     return ScDocFunc::SetCellText( rPos, rText, bInterpret, bEnglish, bApi, eGrammar );
 396 }
 397
 398 bool ScDocFuncSend::ShowNote( const ScAddress& rPos, bool bShow )
 399 {
 400     ScChangeOpWriter aOp( "showNote" );
 401     aOp.appendAddress( rPos );
 402     aOp.appendBool( bShow );
 403     SendMessage( aOp );
 404     return true; // needs some code auditing action
 405 }
 406
 407 bool ScDocFuncSend::SetNoteText( const ScAddress& rPos, const OUString& rNoteText, sal_Bool bApi )
 408 {
 409     ScChangeOpWriter aOp( "setNoteText" );
 410     aOp.appendAddress( rPos );
 411     aOp.appendString( rNoteText );
 412     aOp.appendBool( bApi );
 413     SendMessage( aOp );
 414     return true; // needs some code auditing action
 415 }
 416
 417 sal_Bool ScDocFuncSend::RenameTable( SCTAB nTab, const OUString& rName,
 418                                      sal_Bool bRecord, sal_Bool bApi )
 419 {
 420     ScChangeOpWriter aOp( "renameTable" );
 421     aOp.appendInt( nTab );
 422     aOp.appendString( rName );
 423     aOp.appendBool( bRecord );
 424     aOp.appendBool( bApi );
 425     SendMessage( aOp );
 426     return true; // needs some code auditing action
 427 }
 428
 429 sal_Bool ScDocFuncSend::ApplyAttributes( const ScMarkData& rMark, const ScPatternAttr& rPattern,
 430                                          sal_Bool bRecord, sal_Bool bApi )
 431 {
 432     SAL_INFO( "sc.tubes", "ApplyAttributes not implemented!" );
 433     return ScDocFunc::ApplyAttributes( rMark, rPattern, bRecord, bApi );
 434 }
 435
 436 sal_Bool ScDocFuncSend::ApplyStyle( const ScMarkData& rMark, const OUString& rStyleName,
 437                                     sal_Bool bRecord, sal_Bool bApi )
 438 {
 439     SAL_INFO( "sc.tubes", "ApplyStyle not implemented!" );
 440     return ScDocFunc::ApplyStyle( rMark, rStyleName, bRecord, bApi );
 441 }
 442
 443 sal_Bool ScDocFuncSend::MergeCells( const ScCellMergeOption& rOption, sal_Bool bContents,
 444                              sal_Bool bRecord, sal_Bool bApi )
 445 {
 446     SAL_INFO( "sc.tubes", "MergeCells not implemented!" );
 447     return ScDocFunc::MergeCells( rOption, bContents, bRecord, bApi );
 448 }
 449
 450 ScDocFunc *ScDocShell::CreateDocFunc()
 451 {
 452     if (TeleManager::hasWaitingConference())
 453     {
 454         TeleConference* pConference = TeleManager::getConference();
 455         if (pConference)
 456         {
 457             mpCollaboration->SetConference( pConference );
 458             return new ScDocFuncSend( *this, new ScDocFuncDirect( *this ), mpCollaboration );
 459         }
 460     }
 461     return new ScDocFuncDirect( *this );
 462 }
 463
 464 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */