summaryrefslogtreecommitdiff
path: root/indra/llui/llurlentry.h
blob: c878a74c5fb5eac7e58cfc6417ca9d177518cc6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/**
 * @file llurlentry.h
 * @author Martin Reddy
 * @brief Describes the Url types that can be registered in LLUrlRegistry
 *
 * $LicenseInfo:firstyear=2009&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLURLENTRY_H
#define LL_LLURLENTRY_H

#include "lluuid.h"
#include "lluicolor.h"
#include "llstyle.h"

#include "llavatarname.h"
#include "llhost.h" // for resolving parcel name by parcel id

#include <boost/signals2.hpp>
#include <boost/regex.hpp>
#include <string>
#include <map>

class LLAvatarName;

typedef boost::signals2::signal<void (const std::string& url,
                                      const std::string& label,
                                      const std::string& icon)> LLUrlLabelSignal;
typedef LLUrlLabelSignal::slot_type LLUrlLabelCallback;

///
/// LLUrlEntryBase is the base class of all Url types registered in the
/// LLUrlRegistry. Each derived classes provides a regular expression
/// to match the Url type (e.g., http://... or secondlife://...) along
/// with an optional icon to display next to instances of the Url in
/// a text display and a XUI file to use for any context menu popup.
/// Functions are also provided to compute an appropriate label and
/// tooltip/status bar text for the Url.
///
/// Some derived classes of LLUrlEntryBase may wish to compute an
/// appropriate label for a Url by asking the server for information.
/// You must therefore provide a callback method, so that you can be
/// notified when an updated label has been received from the server.
/// This label should then be used to replace any previous label
/// that you received from getLabel() for the Url in question.
///
class LLUrlEntryBase
{
public:
    LLUrlEntryBase();
    virtual ~LLUrlEntryBase();

    /// Return the regex pattern that matches this Url
    boost::regex getPattern() const { return mPattern; }

    /// Return the url from a string that matched the regex
    virtual std::string getUrl(const std::string &string) const;

    /// Given a matched Url, return a label for the Url
    virtual std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb) { return url; }

    /// Return port, query and fragment parts for the Url
    virtual std::string getQuery(const std::string &url) const { return ""; }

    /// Return an icon that can be displayed next to Urls of this type
    virtual std::string getIcon(const std::string &url);

    /// Return the style to render the displayed text
    virtual LLStyle::Params getStyle() const;

    /// Given a matched Url, return a tooltip string for the hyperlink
    virtual std::string getTooltip(const std::string &string) const { return mTooltip; }

    /// Return the name of a XUI file containing the context menu items
    std::string getMenuName() const { return mMenuName; }

    /// Return the name of a SL location described by this Url, if any
    virtual std::string getLocation(const std::string &url) const { return ""; }

    /// Should this link text be underlined only when mouse is hovered over it?
    virtual bool underlineOnHoverOnly(const std::string &string) const { return false; }

    virtual bool isTrusted() const { return false; }

    virtual LLUUID  getID(const std::string &string) const { return LLUUID::null; }

    bool isLinkDisabled() const;

    bool isWikiLinkCorrect(const std::string &url) const;

    virtual bool isSLURLvalid(const std::string &url) const { return TRUE; };

protected:
    std::string getIDStringFromUrl(const std::string &url) const;
    std::string escapeUrl(const std::string &url) const;
    std::string unescapeUrl(const std::string &url) const;
    std::string getLabelFromWikiLink(const std::string &url) const;
    std::string getUrlFromWikiLink(const std::string &string) const;
    void addObserver(const std::string &id, const std::string &url, const LLUrlLabelCallback &cb);
    std::string urlToLabelWithGreyQuery(const std::string &url) const;
    std::string urlToGreyQuery(const std::string &url) const;
    virtual void callObservers(const std::string &id, const std::string &label, const std::string& icon);

    typedef struct {
        std::string url;
        LLUrlLabelSignal *signal;
    } LLUrlEntryObserver;

    boost::regex                                    mPattern;
    std::string                                     mIcon;
    std::string                                     mMenuName;
    std::string                                     mTooltip;
    std::multimap<std::string, LLUrlEntryObserver>  mObservers;
};

///
/// LLUrlEntryHTTP Describes generic http: and https: Urls
///
class LLUrlEntryHTTP : public LLUrlEntryBase
{
public:
    LLUrlEntryHTTP();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getQuery(const std::string &url) const;
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getTooltip(const std::string &url) const;
};

///
/// LLUrlEntryHTTPLabel Describes generic http: and https: Urls with custom labels
///
class LLUrlEntryHTTPLabel : public LLUrlEntryBase
{
public:
    LLUrlEntryHTTPLabel();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getTooltip(const std::string &string) const;
    /*virtual*/ std::string getUrl(const std::string &string) const;
};

class LLUrlEntryInvalidSLURL : public LLUrlEntryBase
{
public:
    LLUrlEntryInvalidSLURL();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getTooltip(const std::string &url) const;

    bool isSLURLvalid(const std::string &url) const;
};

///
/// LLUrlEntrySLURL Describes http://slurl.com/... Urls
///
class LLUrlEntrySLURL : public LLUrlEntryBase
{
public:
    LLUrlEntrySLURL();
    /*virtual*/ bool isTrusted() const { return true; }
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
};

///
/// LLUrlEntrySeconlifeURLs Describes *secondlife.com and *lindenlab.com Urls
///
class LLUrlEntrySecondlifeURL : public LLUrlEntryBase
{
public:
    LLUrlEntrySecondlifeURL();
    /*virtual*/ bool isTrusted() const { return true; }
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getQuery(const std::string &url) const;
    /*virtual*/ std::string getTooltip(const std::string &url) const;
};

///
/// LLUrlEntrySeconlifeURLs Describes *secondlife.com and *lindenlab.com Urls
///
class LLUrlEntrySimpleSecondlifeURL : public LLUrlEntrySecondlifeURL
{
public:
    LLUrlEntrySimpleSecondlifeURL();
};

///
/// LLUrlEntryAgent Describes a Second Life agent Url, e.g.,
/// secondlife:///app/agent/0e346d8b-4433-4d66-a6b0-fd37083abc4c/about
class LLUrlEntryAgent : public LLUrlEntryBase
{
public:
    LLUrlEntryAgent();
    ~LLUrlEntryAgent()
    {
        for (avatar_name_cache_connection_map_t::iterator it = mAvatarNameCacheConnections.begin(); it != mAvatarNameCacheConnections.end(); ++it)
        {
            if (it->second.connected())
            {
                it->second.disconnect();
            }
        }
        mAvatarNameCacheConnections.clear();
    }
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getIcon(const std::string &url);
    /*virtual*/ std::string getTooltip(const std::string &string) const;
    /*virtual*/ LLStyle::Params getStyle() const;
    /*virtual*/ LLUUID  getID(const std::string &string) const;
    /*virtual*/ bool underlineOnHoverOnly(const std::string &string) const;
protected:
    /*virtual*/ void callObservers(const std::string &id, const std::string &label, const std::string& icon);
private:
    void onAvatarNameCache(const LLUUID& id, const LLAvatarName& av_name);

    typedef std::map<LLUUID, boost::signals2::connection> avatar_name_cache_connection_map_t;
    avatar_name_cache_connection_map_t mAvatarNameCacheConnections;
};

///
/// LLUrlEntryAgentName Describes a Second Life agent name Url, e.g.,
/// secondlife:///app/agent/0e346d8b-4433-4d66-a6b0-fd37083abc4c/(completename|displayname|username)
/// that displays various forms of user name
/// This is a base class for the various implementations of name display
class LLUrlEntryAgentName : public LLUrlEntryBase, public boost::signals2::trackable
{
public:
    LLUrlEntryAgentName();
    ~LLUrlEntryAgentName()
    {
        for (avatar_name_cache_connection_map_t::iterator it = mAvatarNameCacheConnections.begin(); it != mAvatarNameCacheConnections.end(); ++it)
        {
            if (it->second.connected())
            {
                it->second.disconnect();
            }
        }
        mAvatarNameCacheConnections.clear();
    }
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ LLStyle::Params getStyle() const;
protected:
    // override this to pull out relevant name fields
    virtual std::string getName(const LLAvatarName& avatar_name) = 0;
private:
    void onAvatarNameCache(const LLUUID& id, const LLAvatarName& av_name);

    typedef std::map<LLUUID, boost::signals2::connection> avatar_name_cache_connection_map_t;
    avatar_name_cache_connection_map_t mAvatarNameCacheConnections;
};


///
/// LLUrlEntryAgentCompleteName Describes a Second Life agent name Url, e.g.,
/// secondlife:///app/agent/0e346d8b-4433-4d66-a6b0-fd37083abc4c/completename
/// that displays the full display name + user name for an avatar
/// such as "James Linden (james.linden)"
class LLUrlEntryAgentCompleteName : public LLUrlEntryAgentName
{
public:
    LLUrlEntryAgentCompleteName();
private:
    /*virtual*/ std::string getName(const LLAvatarName& avatar_name);
};

class LLUrlEntryAgentLegacyName : public LLUrlEntryAgentName
{
public:
    LLUrlEntryAgentLegacyName();
private:
    /*virtual*/ std::string getName(const LLAvatarName& avatar_name);
};

///
/// LLUrlEntryAgentDisplayName Describes a Second Life agent display name Url, e.g.,
/// secondlife:///app/agent/0e346d8b-4433-4d66-a6b0-fd37083abc4c/displayname
/// that displays the just the display name for an avatar
/// such as "James Linden"
class LLUrlEntryAgentDisplayName : public LLUrlEntryAgentName
{
public:
    LLUrlEntryAgentDisplayName();
private:
    /*virtual*/ std::string getName(const LLAvatarName& avatar_name);
};

///
/// LLUrlEntryAgentUserName Describes a Second Life agent username Url, e.g.,
/// secondlife:///app/agent/0e346d8b-4433-4d66-a6b0-fd37083abc4c/username
/// that displays the just the display name for an avatar
/// such as "james.linden"
class LLUrlEntryAgentUserName : public LLUrlEntryAgentName
{
public:
    LLUrlEntryAgentUserName();
private:
    /*virtual*/ std::string getName(const LLAvatarName& avatar_name);
};

///
/// LLUrlEntryExperienceProfile Describes a Second Life experience profile Url, e.g.,
/// secondlife:///app/experience/0e346d8b-4433-4d66-a6b0-fd37083abc4c/profile
/// that displays the experience name
class LLUrlEntryExperienceProfile : public LLUrlEntryBase
{
public:
    LLUrlEntryExperienceProfile();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
private:
    void onExperienceDetails(const LLSD& experience_details);
};


///
/// LLUrlEntryGroup Describes a Second Life group Url, e.g.,
/// secondlife:///app/group/00005ff3-4044-c79f-9de8-fb28ae0df991/about
///
class LLUrlEntryGroup : public LLUrlEntryBase
{
public:
    LLUrlEntryGroup();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ LLStyle::Params getStyle() const;
    /*virtual*/ LLUUID  getID(const std::string &string) const;
private:
    void onGroupNameReceived(const LLUUID& id, const std::string& name, bool is_group);
};

///
/// LLUrlEntryInventory Describes a Second Life inventory Url, e.g.,
/// secondlife:///app/inventory/0e346d8b-4433-4d66-a6b0-fd37083abc4c/select
///
class LLUrlEntryInventory : public LLUrlEntryBase
{
public:
    LLUrlEntryInventory();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
private:
};

///
/// LLUrlEntryObjectIM Describes a Second Life inspector for the object Url, e.g.,
/// secondlife:///app/objectim/7bcd7864-da6b-e43f-4486-91d28a28d95b?name=Object&owner=3de548e1-57be-cfea-2b78-83ae3ad95998&slurl=Danger!%20Danger!/200/200/30/&groupowned=1
///
class LLUrlEntryObjectIM : public LLUrlEntryBase
{
public:
    LLUrlEntryObjectIM();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
private:
};

//
// LLUrlEntryChat Describes a Second Life chat Url, e.g.,
// secondlife:///app/chat/42/This%20Is%20a%20test
//
class LLUrlEntryChat : public LLUrlEntryBase
{
public:
    LLUrlEntryChat();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
};

///
/// LLUrlEntryParcel Describes a Second Life parcel Url, e.g.,
/// secondlife:///app/parcel/0000060e-4b39-e00b-d0c3-d98b1934e3a8/about
///
class LLUrlEntryParcel : public LLUrlEntryBase
{
public:
    struct LLParcelData
    {
        LLUUID      parcel_id;
        std::string name;
        std::string sim_name;
        F32         global_x;
        F32         global_y;
        F32         global_z;
    };

    LLUrlEntryParcel();
    ~LLUrlEntryParcel();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);

    // Sends a parcel info request to sim.
    void sendParcelInfoRequest(const LLUUID& parcel_id);

    // Calls observers of certain parcel id providing them with parcel label.
    void onParcelInfoReceived(const std::string &id, const std::string &label);

    // Processes parcel label and triggers notifying observers.
    static void processParcelInfo(const LLParcelData& parcel_data);

    // Next 4 setters are used to update agent and viewer connection information
    // upon events like user login, viewer disconnect and user changing region host.
    // These setters are made public to be accessible from newview and should not be
    // used in other cases.
    static void setAgentID(const LLUUID& id) { sAgentID = id; }
    static void setSessionID(const LLUUID& id) { sSessionID = id; }
    static void setRegionHost(const LLHost& host) { sRegionHost = host; }
    static void setDisconnected(bool disconnected) { sDisconnected = disconnected; }

private:
    static LLUUID                       sAgentID;
    static LLUUID                       sSessionID;
    static LLHost                       sRegionHost;
    static bool                         sDisconnected;
    static std::set<LLUrlEntryParcel*>  sParcelInfoObservers;
};

///
/// LLUrlEntryPlace Describes a Second Life location Url, e.g.,
/// secondlife://Ahern/50/50/50
///
class LLUrlEntryPlace : public LLUrlEntryBase
{
public:
    LLUrlEntryPlace();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
};

///
/// LLUrlEntryRegion Describes a Second Life location Url, e.g.,
/// secondlife:///app/region/Ahern/128/128/0
///
class LLUrlEntryRegion : public LLUrlEntryBase
{
public:
    LLUrlEntryRegion();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
};

///
/// LLUrlEntryTeleport Describes a Second Life teleport Url, e.g.,
/// secondlife:///app/teleport/Ahern/50/50/50/
///
class LLUrlEntryTeleport : public LLUrlEntryBase
{
public:
    LLUrlEntryTeleport();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
};

///
/// LLUrlEntrySL Describes a generic SLURL, e.g., a Url that starts
/// with secondlife:// (used as a catch-all for cases not matched above)
///
class LLUrlEntrySL : public LLUrlEntryBase
{
public:
    LLUrlEntrySL();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
};

///
/// LLUrlEntrySLLabel Describes a generic SLURL, e.g., a Url that starts
/// with secondlife:// with the ability to specify a custom label.
///
class LLUrlEntrySLLabel : public LLUrlEntryBase
{
public:
    LLUrlEntrySLLabel();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getTooltip(const std::string &string) const;
    /*virtual*/ bool underlineOnHoverOnly(const std::string &string) const;
};

///
/// LLUrlEntryWorldMap Describes a Second Life worldmap Url, e.g.,
/// secondlife:///app/worldmap/Ahern/50/50/50
///
class LLUrlEntryWorldMap : public LLUrlEntryBase
{
public:
    LLUrlEntryWorldMap();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getLocation(const std::string &url) const;
};

///
/// LLUrlEntryNoLink lets us turn of URL detection with <nolink>...</nolink> tags
///
class LLUrlEntryNoLink : public LLUrlEntryBase
{
public:
    LLUrlEntryNoLink();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ LLStyle::Params getStyle() const;
};

///
/// LLUrlEntryIcon describes an icon with <icon>...</icon> tags
///
class LLUrlEntryIcon : public LLUrlEntryBase
{
public:
    LLUrlEntryIcon();
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getIcon(const std::string &url);
};

///
/// LLUrlEntryEmail Describes a generic mailto: Urls
///
class LLUrlEntryEmail : public LLUrlEntryBase
{
public:
    LLUrlEntryEmail();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getUrl(const std::string &string) const;
};

///
/// LLUrlEntryEmail Describes an IPv6 address
///
class LLUrlEntryIPv6 : public LLUrlEntryBase
{
public:
    LLUrlEntryIPv6();
    /*virtual*/ std::string getLabel(const std::string &url, const LLUrlLabelCallback &cb);
    /*virtual*/ std::string getUrl(const std::string &string) const;
    /*virtual*/ std::string getQuery(const std::string &url) const;

    std::string mHostPath;
};

class LLKeyBindingToStringHandler;

///
/// LLUrlEntryKeybinding A way to access keybindings and show currently used one in text.
/// secondlife:///app/keybinding/control_name
class LLUrlEntryKeybinding: public LLUrlEntryBase
{
public:
    LLUrlEntryKeybinding();
    /*virtual*/ std::string getLabel(const std::string& url, const LLUrlLabelCallback& cb);
    /*virtual*/ std::string getTooltip(const std::string& url) const;
    void setHandler(LLKeyBindingToStringHandler* handler) {pHandler = handler;}
private:
    std::string getControlName(const std::string& url) const;
    std::string getMode(const std::string& url) const;
    void initLocalization();
    void initLocalizationFromFile(const std::string& filename);

    struct LLLocalizationData
    {
        LLLocalizationData() {}
        LLLocalizationData(const std::string& localization, const std::string& tooltip)
            : mLocalization(localization)
            , mTooltip(tooltip)
        {}
        std::string mLocalization;
        std::string mTooltip;
    };

    std::map<std::string, LLLocalizationData> mLocalizations;
    LLKeyBindingToStringHandler* pHandler;
};

#endif