server/clipboard.c

   1 /*
   2  * Server-side clipboard management
   3  *
   4  * Copyright 2002 Ulrich Czekalla
   5  * Copyright 2016 Alexandre Julliard
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 #include "ntstatus.h"
  31 #define WIN32_NO_STATUS
  32 #include "request.h"
  33 #include "object.h"
  34 #include "file.h"
  35 #include "process.h"
  36 #include "user.h"
  37 #include "winuser.h"
  38 #include "winternl.h"
  39
  40 struct clip_format
  41 {
  42     struct list    entry;            /* entry in format list */
  43     unsigned int   id;               /* format id */
  44     unsigned int   from;             /* for synthesized data, format to generate it from */
  45     unsigned int   seqno;            /* sequence number when the data was set */
  46     data_size_t    size;             /* size of the data block */
  47     void          *data;             /* data contents, or NULL for delay-rendered */
  48 };
  49
  50 struct clipboard
  51 {
  52     struct object  obj;              /* object header */
  53     struct thread *open_thread;      /* thread id that has clipboard open */
  54     user_handle_t  open_win;         /* window that has clipboard open */
  55     struct thread *owner_thread;     /* thread id that owns the clipboard */
  56     user_handle_t  owner_win;        /* window that owns the clipboard data */
  57     user_handle_t  viewer;           /* first window in clipboard viewer list */
  58     unsigned int   lcid;             /* locale id to use for synthesizing text formats */
  59     unsigned int   seqno;            /* clipboard change sequence number */
  60     unsigned int   open_seqno;       /* sequence number at open time */
  61     struct list    formats;          /* list of data formats */
  62     unsigned int   format_count;     /* count of data formats */
  63     unsigned int   format_map;       /* existence bitmap for formats < CF_MAX */
  64     unsigned int   listen_size;      /* size of listeners array */
  65     unsigned int   listen_count;     /* count of listeners */
  66     user_handle_t *listeners;        /* array of listener windows */
  67 };
  68
  69 static void clipboard_dump( struct object *obj, int verbose );
  70 static void clipboard_destroy( struct object *obj );
  71
  72 static const struct object_ops clipboard_ops =
  73 {
  74     sizeof(struct clipboard),     /* size */
  75     clipboard_dump,               /* dump */
  76     no_get_type,                  /* get_type */
  77     no_add_queue,                 /* add_queue */
  78     NULL,                         /* remove_queue */
  79     NULL,                         /* signaled */
  80     NULL,                         /* satisfied */
  81     no_signal,                    /* signal */
  82     no_get_fd,                    /* get_fd */
  83     no_map_access,                /* map_access */
  84     default_get_sd,               /* get_sd */
  85     default_set_sd,               /* set_sd */
  86     no_lookup_name,               /* lookup_name */
  87     no_link_name,                 /* link_name */
  88     NULL,                         /* unlink_name */
  89     no_open_file,                 /* open_file */
  90     no_close_handle,              /* close_handle */
  91     clipboard_destroy             /* destroy */
  92 };
  93
  94
  95 #define HAS_FORMAT(map,id) ((map) & (1 << (id)))  /* only for formats < CF_MAX */
  96
  97 /* find a data format in the clipboard */
  98 static struct clip_format *get_format( struct clipboard *clipboard, unsigned int id )
  99 {
 100     struct clip_format *format;
 101
 102     LIST_FOR_EACH_ENTRY( format, &clipboard->formats, struct clip_format, entry )
 103         if (format->id == id) return format;
 104
 105     return NULL;
 106 }
 107
 108 /* add a data format to the clipboard */
 109 static struct clip_format *add_format( struct clipboard *clipboard, unsigned int id )
 110 {
 111     struct clip_format *format;
 112
 113     if (!(format = mem_alloc( sizeof(*format )))) return NULL;
 114     format->id   = id;
 115     format->from = 0;
 116     format->size = 0;
 117     format->data = NULL;
 118     list_add_tail( &clipboard->formats, &format->entry );
 119     clipboard->format_count++;
 120     if (id < CF_MAX) clipboard->format_map |= 1 << id;
 121     return format;
 122 }
 123
 124 /* free all clipboard formats */
 125 static void free_clipboard_formats( struct clipboard *clipboard )
 126 {
 127     struct clip_format *format, *next;
 128
 129     LIST_FOR_EACH_ENTRY_SAFE( format, next, &clipboard->formats, struct clip_format, entry )
 130     {
 131         list_remove( &format->entry );
 132         free( format->data );
 133         free( format );
 134     }
 135     clipboard->format_count = 0;
 136     clipboard->format_map = 0;
 137 }
 138
 139 /* dump a clipboard object */
 140 static void clipboard_dump( struct object *obj, int verbose )
 141 {
 142     struct clipboard *clipboard = (struct clipboard *)obj;
 143
 144     fprintf( stderr, "Clipboard open_thread=%p open_win=%08x owner_thread=%p owner_win=%08x viewer=%08x seq=%u\n",
 145              clipboard->open_thread, clipboard->open_win, clipboard->owner_thread,
 146              clipboard->owner_win, clipboard->viewer, clipboard->seqno );
 147 }
 148
 149 static void clipboard_destroy( struct object *obj )
 150 {
 151     struct clipboard *clipboard = (struct clipboard *)obj;
 152
 153     free( clipboard->listeners );
 154     free_clipboard_formats( clipboard );
 155 }
 156
 157 /* retrieve the clipboard info for the current process, allocating it if needed */
 158 static struct clipboard *get_process_clipboard(void)
 159 {
 160     struct clipboard *clipboard;
 161     struct winstation *winstation = get_process_winstation( current->process, WINSTA_ACCESSCLIPBOARD );
 162
 163     if (!winstation) return NULL;
 164
 165     if (!(clipboard = winstation->clipboard))
 166     {
 167         if ((clipboard = alloc_object( &clipboard_ops )))
 168         {
 169             clipboard->open_thread = NULL;
 170             clipboard->open_win = 0;
 171             clipboard->owner_thread = NULL;
 172             clipboard->owner_win = 0;
 173             clipboard->viewer = 0;
 174             clipboard->seqno = 0;
 175             clipboard->format_count = 0;
 176             clipboard->format_map = 0;
 177             clipboard->listen_size = 0;
 178             clipboard->listen_count = 0;
 179             clipboard->listeners = NULL;
 180             list_init( &clipboard->formats );
 181             winstation->clipboard = clipboard;
 182         }
 183     }
 184     release_object( winstation );
 185     return clipboard;
 186 }
 187
 188 /* add synthesized formats upon clipboard close */
 189 static int synthesize_formats( struct clipboard *clipboard )
 190 {
 191     static const unsigned int formats[][3] =
 192     {
 193         { CF_TEXT, CF_OEMTEXT, CF_UNICODETEXT },
 194         { CF_OEMTEXT, CF_UNICODETEXT, CF_TEXT },
 195         { CF_UNICODETEXT, CF_TEXT, CF_OEMTEXT },
 196         { CF_METAFILEPICT, CF_ENHMETAFILE },
 197         { CF_ENHMETAFILE, CF_METAFILEPICT },
 198         { CF_BITMAP, CF_DIB, CF_DIBV5 },
 199         { CF_DIB, CF_BITMAP, CF_DIBV5 },
 200         { CF_DIBV5, CF_BITMAP, CF_DIB }
 201     };
 202     unsigned int i, from, total = 0, map = clipboard->format_map;
 203     struct clip_format *format;
 204
 205     if (!HAS_FORMAT( map, CF_LOCALE ) &&
 206         (HAS_FORMAT( map, CF_TEXT ) || HAS_FORMAT( map, CF_OEMTEXT ) || HAS_FORMAT( map, CF_UNICODETEXT )))
 207     {
 208         void *data = memdup( &clipboard->lcid, sizeof(clipboard->lcid) );
 209         if (data && (format = add_format( clipboard, CF_LOCALE )))
 210         {
 211             format->seqno = clipboard->seqno++;
 212             format->data  = data;
 213             format->size  = sizeof(clipboard->lcid);
 214         }
 215         else free( data );
 216     }
 217
 218     for (i = 0; i < sizeof(formats) / sizeof(formats[0]); i++)
 219     {
 220         if (HAS_FORMAT( map, formats[i][0] )) continue;
 221         if (HAS_FORMAT( map, formats[i][1] )) from = formats[i][1];
 222         else if (HAS_FORMAT( map, formats[i][2] )) from = formats[i][2];
 223         else continue;
 224         if (!(format = add_format( clipboard, formats[i][0] ))) continue;
 225         format->from = from;
 226         format->seqno = clipboard->seqno;
 227         total++;
 228     }
 229     return total;
 230 }
 231
 232 /* add a clipboard listener */
 233 static void add_listener( struct clipboard *clipboard, user_handle_t window )
 234 {
 235     unsigned int i;
 236
 237     for (i = 0; i < clipboard->listen_count; i++)
 238     {
 239         if (clipboard->listeners[i] != window) continue;
 240         set_error( STATUS_INVALID_PARAMETER );  /* already set */
 241         return;
 242     }
 243     if (clipboard->listen_size == clipboard->listen_count)
 244     {
 245         unsigned int new_size = max( 8, clipboard->listen_size * 2 );
 246         user_handle_t *new = realloc( clipboard->listeners, new_size * sizeof(*new) );
 247         if (!new)
 248         {
 249             set_error( STATUS_NO_MEMORY );
 250             return;
 251         }
 252         clipboard->listeners = new;
 253         clipboard->listen_size = new_size;
 254     }
 255     clipboard->listeners[clipboard->listen_count++] = window;
 256 }
 257
 258 /* remove a clipboard listener */
 259 static int remove_listener( struct clipboard *clipboard, user_handle_t window )
 260 {
 261     unsigned int i;
 262
 263     for (i = 0; i < clipboard->listen_count; i++)
 264     {
 265         if (clipboard->listeners[i] != window) continue;
 266         memmove( clipboard->listeners + i, clipboard->listeners + i + 1,
 267                  (clipboard->listen_count - i - 1) * sizeof(*clipboard->listeners) );
 268         clipboard->listen_count--;
 269         return 1;
 270     }
 271     return 0;
 272 }
 273
 274 /* notify all listeners, and return the viewer window that should be notified if any */
 275 static user_handle_t notify_listeners( struct clipboard *clipboard )
 276 {
 277     unsigned int i;
 278
 279     for (i = 0; i < clipboard->listen_count; i++)
 280         post_message( clipboard->listeners[i], WM_CLIPBOARDUPDATE, 0, 0 );
 281     return clipboard->viewer;
 282 }
 283
 284 /* close the clipboard, and return the viewer window that should be notified if any */
 285 static user_handle_t close_clipboard( struct clipboard *clipboard )
 286 {
 287     clipboard->open_win = 0;
 288     clipboard->open_thread = NULL;
 289     if (clipboard->seqno == clipboard->open_seqno) return 0;  /* unchanged */
 290     if (synthesize_formats( clipboard )) clipboard->seqno++;
 291     return notify_listeners( clipboard );
 292 }
 293
 294 /* release the clipboard owner, and return the viewer window that should be notified if any */
 295 static user_handle_t release_clipboard( struct clipboard *clipboard )
 296 {
 297     struct clip_format *format, *next;
 298     int changed = 0;
 299
 300     clipboard->owner_win = 0;
 301     clipboard->owner_thread = NULL;
 302
 303     /* free the delayed-rendered formats, since we no longer have an owner to render them */
 304     LIST_FOR_EACH_ENTRY_SAFE( format, next, &clipboard->formats, struct clip_format, entry )
 305     {
 306         if (format->data || format->from) continue;
 307         list_remove( &format->entry );
 308         if (format->id < CF_MAX) clipboard->format_map &= ~(1 << format->id);
 309         clipboard->format_count--;
 310         free( format );
 311         changed = 1;
 312     }
 313
 314     if (!changed) return 0;
 315     clipboard->seqno++;
 316     return notify_listeners( clipboard );
 317 }
 318
 319 /* cleanup clipboard information upon window destruction */
 320 void cleanup_clipboard_window( struct desktop *desktop, user_handle_t window )
 321 {
 322     struct clipboard *clipboard = desktop->winstation->clipboard;
 323
 324     if (!clipboard) return;
 325
 326     remove_listener( clipboard, window );
 327     if (clipboard->viewer == window) clipboard->viewer = 0;
 328     if (clipboard->owner_win == window) release_clipboard( clipboard );
 329     if (clipboard->open_win == window)
 330     {
 331         user_handle_t viewer = close_clipboard( clipboard );
 332         if (viewer) send_notify_message( viewer, WM_DRAWCLIPBOARD, clipboard->owner_win, 0 );
 333     }
 334 }
 335
 336 /* Called when thread terminates to allow release of clipboard */
 337 void cleanup_clipboard_thread(struct thread *thread)
 338 {
 339     struct clipboard *clipboard;
 340     struct winstation *winstation;
 341
 342     if (!thread->process->winstation) return;
 343     if (!(winstation = get_process_winstation( thread->process, WINSTA_ACCESSCLIPBOARD ))) return;
 344
 345     if ((clipboard = winstation->clipboard))
 346     {
 347         if (thread == clipboard->owner_thread) clipboard->owner_thread = NULL;
 348         if (thread == clipboard->open_thread)
 349         {
 350             user_handle_t viewer = close_clipboard( clipboard );
 351             if (viewer) send_notify_message( viewer, WM_DRAWCLIPBOARD, clipboard->owner_win, 0 );
 352         }
 353     }
 354     release_object( winstation );
 355 }
 356
 357 static int release_clipboard_owner( struct clipboard *clipboard, user_handle_t win )
 358 {
 359     if ((clipboard->open_thread && clipboard->open_thread->process != current->process) ||
 360         (win && clipboard->owner_win != get_user_full_handle( win )))
 361     {
 362         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 363         return 0;
 364     }
 365     clipboard->owner_win = 0;
 366     clipboard->owner_thread = NULL;
 367     return 1;
 368 }
 369
 370
 371 /* open the clipboard */
 372 DECL_HANDLER(open_clipboard)
 373 {
 374     struct clipboard *clipboard = get_process_clipboard();
 375     user_handle_t win = 0;
 376
 377     if (!clipboard) return;
 378     if (req->window && !(win = get_valid_window_handle( req->window ))) return;
 379
 380     if (clipboard->open_thread && clipboard->open_win != win)
 381     {
 382         set_error( STATUS_INVALID_LOCK_SEQUENCE );
 383         return;
 384     }
 385
 386     if (!clipboard->open_thread) clipboard->open_seqno = clipboard->seqno; /* first open */
 387     clipboard->open_win = win;
 388     clipboard->open_thread = current;
 389
 390     reply->owner = clipboard->owner_win;
 391 }
 392
 393
 394 /* close the clipboard */
 395 DECL_HANDLER(close_clipboard)
 396 {
 397     struct clipboard *clipboard = get_process_clipboard();
 398
 399     if (!clipboard) return;
 400
 401     if (clipboard->open_thread != current)
 402     {
 403         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 404         return;
 405     }
 406     reply->viewer = close_clipboard( clipboard );
 407     reply->owner  = clipboard->owner_win;
 408 }
 409
 410
 411 DECL_HANDLER(set_clipboard_info)
 412 {
 413     struct clipboard *clipboard = get_process_clipboard();
 414
 415     if (!clipboard) return;
 416
 417     reply->old_clipboard = clipboard->open_win;
 418     reply->old_owner     = clipboard->owner_win;
 419     reply->old_viewer    = clipboard->viewer;
 420
 421     if (req->flags & SET_CB_RELOWNER)
 422     {
 423         if (!release_clipboard_owner( clipboard, req->owner )) return;
 424     }
 425
 426     if (req->flags & SET_CB_SEQNO) clipboard->seqno++;
 427
 428     reply->seqno = clipboard->seqno;
 429
 430     if (clipboard->open_thread) reply->flags |= CB_OPEN_ANY;
 431     if (clipboard->open_thread == current) reply->flags |= CB_OPEN;
 432     if (clipboard->owner_thread == current) reply->flags |= CB_OWNER;
 433     if (clipboard->owner_thread && clipboard->owner_thread->process == current->process)
 434         reply->flags |= CB_PROCESS;
 435 }
 436
 437
 438 /* add a data format to the clipboard */
 439 DECL_HANDLER(set_clipboard_data)
 440 {
 441     struct clip_format *format;
 442     struct clipboard *clipboard = get_process_clipboard();
 443     void *data = NULL;
 444
 445     if (!clipboard) return;
 446
 447     if (!req->format || !clipboard->open_thread)
 448     {
 449         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 450         return;
 451     }
 452
 453     if (get_req_data_size() && !(data = memdup( get_req_data(), get_req_data_size() ))) return;
 454
 455     if (!(format = get_format( clipboard, req->format )))
 456     {
 457         if (!(format = add_format( clipboard, req->format )))
 458         {
 459             free( data );
 460             return;
 461         }
 462     }
 463
 464     free( format->data );
 465     format->from   = 0;
 466     format->seqno  = clipboard->seqno++;
 467     format->size   = get_req_data_size();
 468     format->data   = data;
 469
 470     if (req->format == CF_TEXT || req->format == CF_OEMTEXT || req->format == CF_UNICODETEXT)
 471         clipboard->lcid = req->lcid;
 472
 473     reply->seqno = format->seqno;
 474 }
 475
 476
 477 /* fetch a data format from the clipboard */
 478 DECL_HANDLER(get_clipboard_data)
 479 {
 480     struct clip_format *format;
 481     struct clipboard *clipboard = get_process_clipboard();
 482
 483     if (!clipboard) return;
 484
 485     if (clipboard->open_thread != current)
 486     {
 487         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 488         return;
 489     }
 490     if (!(format = get_format( clipboard, req->format )))
 491     {
 492         set_error( STATUS_OBJECT_NAME_NOT_FOUND );
 493         return;
 494     }
 495     reply->from   = format->from;
 496     reply->total  = format->size;
 497     reply->seqno  = format->seqno;
 498     if (!format->data && !format->from) reply->owner = clipboard->owner_win;
 499     if (req->cached && req->seqno == format->seqno) return;  /* client-side cache still valid */
 500     if (format->size <= get_reply_max_size()) set_reply_data( format->data, format->size );
 501     else set_error( STATUS_BUFFER_OVERFLOW );
 502 }
 503
 504
 505 /* retrieve a list of available formats */
 506 DECL_HANDLER(get_clipboard_formats)
 507 {
 508     struct clipboard *clipboard = get_process_clipboard();
 509
 510     if (!clipboard) return;
 511
 512     if (!req->format)
 513     {
 514         struct clip_format *format;
 515         unsigned int i = 0, *ptr;
 516         data_size_t size = clipboard->format_count * sizeof(unsigned int);
 517
 518         reply->count = clipboard->format_count;
 519         if (size <= get_reply_max_size())
 520         {
 521             if ((ptr = mem_alloc( size )))
 522             {
 523                 LIST_FOR_EACH_ENTRY( format, &clipboard->formats, struct clip_format, entry )
 524                     ptr[i++] = format->id;
 525                 assert( i == clipboard->format_count );
 526                 set_reply_data_ptr( ptr, size );
 527             }
 528         }
 529         else set_error( STATUS_BUFFER_TOO_SMALL );
 530     }
 531     else reply->count = (get_format( clipboard, req->format ) != NULL);  /* query a single format */
 532 }
 533
 534
 535 /* retrieve the next available format */
 536 DECL_HANDLER(enum_clipboard_formats)
 537 {
 538     struct list *ptr;
 539     struct clipboard *clipboard = get_process_clipboard();
 540
 541     if (!clipboard) return;
 542
 543     if (clipboard->open_thread != current)
 544     {
 545         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 546         return;
 547     }
 548
 549     ptr = list_head( &clipboard->formats );
 550     if (req->previous)
 551     {
 552         while (ptr && LIST_ENTRY( ptr, struct clip_format, entry )->id != req->previous)
 553             ptr = list_next( &clipboard->formats, ptr );
 554         if (ptr) ptr = list_next( &clipboard->formats, ptr );
 555     }
 556     if (ptr) reply->format = LIST_ENTRY( ptr, struct clip_format, entry )->id;
 557 }
 558
 559
 560 /* empty the clipboard and grab ownership */
 561 DECL_HANDLER(empty_clipboard)
 562 {
 563     struct clipboard *clipboard = get_process_clipboard();
 564
 565     if (!clipboard) return;
 566
 567     if (clipboard->open_thread != current)
 568     {
 569         set_win32_error( ERROR_CLIPBOARD_NOT_OPEN );
 570         return;
 571     }
 572
 573     free_clipboard_formats( clipboard );
 574     clipboard->owner_win = clipboard->open_win;
 575     clipboard->owner_thread = clipboard->open_thread;
 576     clipboard->seqno++;
 577 }
 578
 579
 580 /* release ownership of the clipboard */
 581 DECL_HANDLER(release_clipboard)
 582 {
 583     struct clipboard *clipboard = get_process_clipboard();
 584     user_handle_t owner;
 585
 586     if (!clipboard) return;
 587
 588     if (!(owner = get_valid_window_handle( req->owner ))) return;
 589
 590     if (clipboard->owner_win == owner)
 591     {
 592         reply->viewer = release_clipboard( clipboard );
 593         reply->owner = clipboard->owner_win;
 594     }
 595     else set_error( STATUS_INVALID_OWNER );
 596 }
 597
 598
 599 /* get clipboard information */
 600 DECL_HANDLER(get_clipboard_info)
 601 {
 602     struct clipboard *clipboard = get_process_clipboard();
 603
 604     if (!clipboard) return;
 605
 606     reply->window = clipboard->open_win;
 607     reply->owner  = clipboard->owner_win;
 608     reply->viewer = clipboard->viewer;
 609     reply->seqno  = clipboard->seqno;
 610 }
 611
 612
 613 /* set the clipboard viewer window */
 614 DECL_HANDLER(set_clipboard_viewer)
 615 {
 616     struct clipboard *clipboard = get_process_clipboard();
 617     user_handle_t viewer = 0, previous = 0;
 618
 619     if (!clipboard) return;
 620     if (req->viewer && !(viewer = get_valid_window_handle( req->viewer ))) return;
 621     if (req->previous && !(previous = get_valid_window_handle( req->previous ))) return;
 622
 623     reply->old_viewer = clipboard->viewer;
 624     reply->owner      = clipboard->owner_win;
 625
 626     if (!previous || clipboard->viewer == previous)
 627         clipboard->viewer = viewer;
 628     else
 629         set_error( STATUS_PENDING );  /* need to send message instead */
 630 }
 631
 632
 633 /* add a clipboard listener window */
 634 DECL_HANDLER(add_clipboard_listener)
 635 {
 636     struct clipboard *clipboard = get_process_clipboard();
 637     user_handle_t win;
 638
 639     if (!clipboard) return;
 640     if (!(win = get_valid_window_handle( req->window ))) return;
 641
 642     add_listener( clipboard, win );
 643 }
 644
 645
 646 /* remove a clipboard listener window */
 647 DECL_HANDLER(remove_clipboard_listener)
 648 {
 649     struct clipboard *clipboard = get_process_clipboard();
 650     user_handle_t win;
 651
 652     if (!clipboard) return;
 653     if (!(win = get_valid_window_handle( req->window ))) return;
 654
 655     if (!remove_listener( clipboard, win )) set_error( STATUS_INVALID_PARAMETER );
 656 }